Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
The Glow documentation is published with [Read the Docs](https://readthedocs.org/).

To build the docs locally, activate the dev conda environment in `python/environment.yml` and then
run `make livehtml` from this directory.
11 changes: 1 addition & 10 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,16 +100,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
'page_width': '85%',
'sidebar_width': '15%'
}
html_theme = 'sphinx_rtd_theme'

# 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,
Expand Down
1 change: 1 addition & 0 deletions python/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ dependencies:
- setuptools==41.2.0 # Python packaging
- typeguard==2.5.0
- twine==2.0.0 # Pypi publishing
- sphinx_rtd_theme