From 77d6ee8118a9d551a3dcf52f86c1976ce4d2f326 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 3 Jan 2020 17:17:41 -0800 Subject: [PATCH] Another attempt to make rtd happy --- .readthedocs.yml | 24 ++++++++++++++++++++++++ docs/Makefile | 2 +- {etc/docs => docs}/conf.py | 3 --- {etc/docs => docs}/requirements.txt | 0 4 files changed, 25 insertions(+), 4 deletions(-) create mode 100644 .readthedocs.yml rename {etc/docs => docs}/conf.py (98%) rename {etc/docs => docs}/requirements.txt (100%) diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..35662209 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,24 @@ +# .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: etc/docs/conf.py + +# Build documentation with MkDocs +#mkdocs: +# configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: etc/docs/requirements.txt + diff --git a/docs/Makefile b/docs/Makefile index 333950eb..41b42094 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line, and also # from the environment for the first two. -SPHINXOPTS ?= -c ../etc/docs +SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = ../out/docs diff --git a/etc/docs/conf.py b/docs/conf.py similarity index 98% rename from etc/docs/conf.py rename to docs/conf.py index 4f146be6..706bdc60 100644 --- a/etc/docs/conf.py +++ b/docs/conf.py @@ -93,9 +93,6 @@ if not on_rtd: # only import and set the theme if we're building docs locally html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] -if on_rtd: - master_doc = '../../docs/index' - # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". diff --git a/etc/docs/requirements.txt b/docs/requirements.txt similarity index 100% rename from etc/docs/requirements.txt rename to docs/requirements.txt