From 006a4f3779ca89c728e98d69b082a6061491932d Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Sun, 6 May 2018 12:43:06 -0700 Subject: [PATCH] create sitemap.xml - install https://github.com/jdillard/sphinx-sitemap - see https://github.com/MDAnalysis/MDAnalysis.github.io/issues/78 --- .travis.yml | 1 + docs/conf.py | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/.travis.yml b/.travis.yml index c4e60340..29a37327 100644 --- a/.travis.yml +++ b/.travis.yml @@ -20,6 +20,7 @@ env: - CONDA_DEPENDENCIES="mdanalysis mdanalysistests dask joblib pytest-pep8 mock codecov" - CONDA_CHANNELS='conda-forge' - CONDA_CHANNEL_PRIORITY=True + - PIP_DEPENDENCIES="sphinx-sitemap" - NUMPY_VERSION=stable - BUILD_CMD='python setup.py develop' - CODECOV=false diff --git a/docs/conf.py b/docs/conf.py index 4dcc66ba..809969ba 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -32,10 +32,14 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', 'sphinx.ext.todo', + 'sphinx_sitemap', 'alabaster'] 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 +site_url = "https://www.mdanalysis.org/pmda/" + # https://stackoverflow.com/questions/5599254/how-to-use-sphinxs-autodoc-to-document-a-classs-init-self-method autoclass_content = 'both'