use versioneer for version management (#88)
- fix #87 - user versioneer for version management - use tag "vMAJOR.MINOR.PATCH" to indicate release number - exclude generated files from coverage; also exclude tests from coverage reporting; allow use of "# pragma: no cover" to exclude lines of code from coverage - configure coverage with entries in setup.cfg (removed commandline config from workflows/python-package.yml) - related doc updates - make docs automatically use current version (docs use versioneer-based propka.__version__) - also added @IAlibay to authors (forgotten in previous PRs #84 and #85) - generate a sitemap (add sphinx_sitemap to requirements.txt) - add test_version Note: Versioneer-generated version is “0-untagged” on the branch where it is tested so need to add it to a valid result.
This commit is contained in:
@@ -24,11 +24,14 @@ import sphinx_rtd_theme
|
||||
# -- 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 ---------------------------------------------------
|
||||
@@ -39,14 +42,14 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
|
||||
'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']
|
||||
|
||||
Reference in New Issue
Block a user