Skip to content

Commit

Permalink
fix: Add docs and webhook yaml for readthedocs
Browse files Browse the repository at this point in the history
fix: Add docs and webhook yaml for readthedocs
  • Loading branch information
math411 authored Nov 28, 2022
2 parents b9ef30b + 33ff395 commit c5702b4
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 3 deletions.
22 changes: 22 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/conf.py

# Optionally build your docs in additional formats such as PDF
formats:
- pdf

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- method: pip
path: .
- requirements: doc/requirements.txt
9 changes: 6 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
###############################
Amazon Braket Algorithm Library
====================
###############################

This text is to be filled in.
The Braket Algorithm Library provides Amazon Braket customers with pre-built implementations of prominent quantum algorithms and experimental workloads as ready-to-run example notebooks.

Indices and tables
Currently, Braket algorithms are tested on Linux, Windows, and Mac.

Running notebooks locally requires additional dependencies located in notebooks/textbook/requirements.txt https://github.com/aws-samples/amazon-braket-algorithm-library/blob/main/notebooks/textbook/requirements.txt. See notebooks/textbook/README.md for more information.
__________________

* :doc:`_apidoc/modules`
Expand Down

0 comments on commit c5702b4

Please sign in to comment.