diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2015-06-07 09:06:05 -0400 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2015-06-07 09:06:05 -0400 |
| commit | c9dbaab97543418212e3d660e9140f866e055c49 (patch) | |
| tree | d190f7f9c813ac64100fb950fa3614a85ea267bd | |
| parent | b92c8a9ea95bdd1a815b54ec2b733469e28ac5cb (diff) | |
| parent | 89a0db3a9e6defe3cbbb4da0fa538c5f9d3e3b93 (diff) | |
| download | pyopenssl-git-c9dbaab97543418212e3d660e9140f866e055c49.tar.gz | |
Merge pull request #272 from hynek/use-rtd-theme
Use RTD theme
| -rw-r--r-- | MANIFEST.in | 2 | ||||
| -rw-r--r-- | doc/README | 2 | ||||
| -rw-r--r-- | doc/conf.py | 7 | ||||
| -rw-r--r-- | doc/index.rst | 1 | ||||
| -rw-r--r-- | docs-requirements.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 3 |
6 files changed, 11 insertions, 6 deletions
diff --git a/MANIFEST.in b/MANIFEST.in index 7b6f3e7..649d521 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include LICENSE ChangeLog MANIFEST.in *.rst tox.ini memdbg.py runtests.py OpenSSL/test/README +include LICENSE ChangeLog MANIFEST.in *.rst tox.ini memdbg.py runtests.py OpenSSL/test/README docs-requirements.txt exclude leakcheck recursive-include doc * recursive-include examples * @@ -1,4 +1,4 @@ This is the pyOpenSSL documentation source. It uses Sphinx. To build the -documentation, install Sphinx 1.0 and run: +documentation, install Sphinx and run: $ make html diff --git a/doc/conf.py b/doc/conf.py index 8277202..5d34ae7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -121,7 +121,12 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'classic' +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # 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 diff --git a/doc/index.rst b/doc/index.rst index e4a5a23..7006ec6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -23,4 +23,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/docs-requirements.txt b/docs-requirements.txt new file mode 100644 index 0000000..8213302 --- /dev/null +++ b/docs-requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinx_rtd_theme @@ -45,8 +45,7 @@ commands = check-manifest [testenv:docs] -deps = - sphinx +deps = -rdocs-requirements.txt basepython = python2.7 commands = sphinx-build -W -b html doc doc/_build/html |