Skip to content

Commit

Permalink
Fix docs (#454)
Browse files Browse the repository at this point in the history
* Update docs config
* Unfix version of rtd theme
* Few minor fixes in Sphinx config
  • Loading branch information
apaleyes authored Oct 17, 2023
1 parent 262c00e commit ff16dc9
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 9 deletions.
15 changes: 15 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 3 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand Down
5 changes: 0 additions & 5 deletions readthedocs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion requirements/doc_requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit ff16dc9

Please sign in to comment.