Skip to content

Commit

Permalink
Feature/rtd document setup (#35)
Browse files Browse the repository at this point in the history
* Updated pyproject to build docs

- Read The Docs doesn't support poetry so had to add a
workaround.

* Set the master doc to index

* Added sphinx to dev dependencies

Co-authored-by: Ciaran McCormick <ciaran@ciaranmccormick.com>
  • Loading branch information
ciaranmccormick and ciaranmccormick committed Apr 12, 2020
1 parent 6c8f630 commit 7164b9c
Show file tree
Hide file tree
Showing 4 changed files with 98 additions and 82 deletions.
8 changes: 8 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
build:
image: latest

python:
version: 3.8
pip_install: true
extra_requirements:
- docs
4 changes: 4 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,7 @@
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]


# Set master doc
master_doc = "index"

0 comments on commit 7164b9c

Please sign in to comment.