Skip to content

Commit f76a493

Browse files
committed
fix readthedocs
1 parent f4f5d57 commit f76a493

File tree

3 files changed

+30
-0
lines changed

3 files changed

+30
-0
lines changed

.readthedocs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Build documentation in the docs/ directory with Sphinx
9+
sphinx:
10+
configuration: docs/conf.py
11+
12+
# Build documentation with MkDocs
13+
#mkdocs:
14+
# configuration: mkdocs.yml
15+
16+
# Optionally build your docs in additional formats such as PDF and ePub
17+
#formats: all
18+
19+
# Optionally set the version of Python and requirements required to build your docs
20+
python:
21+
version: 3.7
22+
install:
23+
- requirements: docs/requirements.txt
24+
- method: pip
25+
path: .

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,4 @@
7777

7878
locale_dirs = ["locale/"] # path is example but recommended.
7979
gettext_compact = False # optional.
80+
master_doc = "index"

docs/requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
sphinx-rtd-theme==0.4.3
2+
sphinxcontrib-apidoc==0.3.0
3+
sphinx-autobuild==0.7.1
4+
sphinx-intl[transifex]==2.0.0

0 commit comments

Comments
 (0)