Skip to content

Commit

Permalink
Add doc config
Browse files Browse the repository at this point in the history
  • Loading branch information
SurrealMind committed Jun 1, 2020
1 parent 05c7103 commit c41cd7c
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# .readthedocs.yml
# Read the Docs configuration file

# Required
version: 2

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

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# 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.7
install:
- requirements: docs/requirements.txt
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@
import sys

sys.path.insert(0, os.path.abspath("../"))
autodoc_mock_imports = ['cirq']
autodoc_mock_imports = ['qiskit']

project = "Arline Quantum"
copyright = "Copyright (C) 2019-2020 Turation Ltd"
Expand Down
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
numpy>=1.18.3
scipy>=1.3.1
sympy>=1.5

0 comments on commit c41cd7c

Please sign in to comment.