Skip to content

Commit

Permalink
make docs automatically use current version
Browse files Browse the repository at this point in the history
- docs use versioneer-based propka.__version__
- also added @IAlibay to authors (forgotten in previous
  PRs jensengroup#84 and jensengroup#85)
- generate a sitemap (add sphinx_sitemap to requirements.txt)
  • Loading branch information
orbeckst committed Jul 18, 2020
1 parent 013f793 commit 1f02b71
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,14 @@
# -- Project information -----------------------------------------------------

project = 'PROPKA 3'
copyright = '2020, Jan H. Jensen, Chresten R. Søndergaard, Mats H. M. Olsson, Michał Rostkowski, Nathan A. Baker, Matvey Adzhigirey, Oliver Beckstein, Jimmy Charnley Kromann, Mike Beachy, Toni G, Thomas Holder'
author = 'Jan H. Jensen, Chresten R. Søndergaard, Mats H. M. Olsson, Michał Rostkowski, Nathan A. Baker, Matvey Adzhigirey, Oliver Beckstein, Jimmy Charnley Kromann, Mike Beachy, Toni G, Thomas Holder'
author = ('Jan H. Jensen, Chresten R. Søndergaard, Mats H. M. Olsson, '
'Michał Rostkowski, Nathan A. Baker, Matvey Adzhigirey, '
'Oliver Beckstein, Jimmy Charnley Kromann, Mike Beachy, '
'Toni G, Thomas Holder, Irfan Alibay')
copyright = '2020, ' + author

# The full version, including alpha/beta/rc tags
release = '3.2.0'
release = __import__('propka').__version__


# -- General configuration ---------------------------------------------------
Expand All @@ -39,14 +42,14 @@
'sphinx.ext.mathjax', 'sphinx.ext.viewcode',
'sphinx.ext.napoleon', 'sphinx.ext.todo',
'sphinx.ext.autosummary',
## 'sphinx_sitemap',
'sphinx_sitemap',
'sphinx_rtd_theme']

mathjax_path = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML'

# for sitemap with https://github.com/jdillard/sphinx-sitemap
# change if we put it under a custom domain; for right now, assume RTD
##site_url = "https://propka.readthedocs.io"
site_url = "https://propka.readthedocs.io"

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ pytest
numpy
sphinx>=3.1
sphinx_rtd_theme
sphinx_sitemap

0 comments on commit 1f02b71

Please sign in to comment.