diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..73f44564 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,15 @@ +# we just follow https://docs.readthedocs.io/en/stable/config-file/v2.html + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.9" + +sphinx: + configuration: doc/conf.py + +python: + install: + - requirements: requirements/doc_requirements.txt diff --git a/doc/conf.py b/doc/conf.py index d81f33ab..1f4d6aa1 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -35,7 +35,7 @@ def __getattr__(cls, name): # -- Project information ----------------------------------------------------- project = 'emukit' -copyright = '{}, Amazon.com'.format(datetime.now().year) +copyright = '{}, Emukit authors'.format(datetime.now().year) exec(open("../emukit/__version__.py").read()) version = __version__ # noqa: variable __version__ is defined in exec above @@ -101,7 +101,7 @@ def __getattr__(cls, name): # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' @@ -154,7 +154,7 @@ def __getattr__(cls, name): # -- intersphinx extension -- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} # -- nbsphinx extension -- # Allow notebooks to have errors when generating docs diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index 1afb6e70..00000000 --- a/readthedocs.yml +++ /dev/null @@ -1,5 +0,0 @@ -build: - image: latest - -python: - version: 3.6 \ No newline at end of file diff --git a/requirements/doc_requirements.txt b/requirements/doc_requirements.txt index 29430a60..8e46b2fb 100644 --- a/requirements/doc_requirements.txt +++ b/requirements/doc_requirements.txt @@ -5,4 +5,4 @@ Sphinx>=1.7.5 nbsphinx>=0.3.4 sphinx-autodoc-typehints>=1.3.0 -sphinx-rtd-theme==0.4.1 +sphinx-rtd-theme>=0.4.1