Skip to content

Commit

Permalink
add sitemap.xml to sphinx docs
Browse files Browse the repository at this point in the history
- install https://github.com/jdillard/sphinx-sitemap with pip
- create sitemap.xml that is correct for the RELEASE docs
  (it is incorrect for the development docs but we do not want to
  index the devdocs anyway... but we could change it so that by default
  it is correct for devdocs and then we fix sitemap.xml when we manually
  add the release docs with the maintainer/deploy_master_docs.sh script)
- see MDAnalysis/MDAnalysis.github.io#78
  • Loading branch information
orbeckst committed May 7, 2018
1 parent 7a7dd60 commit 2758574
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ env:
- CONDA_DEPENDENCIES="${CONDA_MIN_DEPENDENCIES} seaborn>=0.7.0 clustalw=2.1 netcdf4 scikit-learn coveralls"
- CONDA_CHANNELS='biobuilds conda-forge'
- CONDA_CHANNEL_PRIORITY=True
- PIP_DEPENDENCIES="duecredit"
- PIP_DEPENDENCIES="duecredit sphinx-sitemap"
- NUMPY_VERSION=stable
- INSTALL_HOLE="true"

Expand Down
7 changes: 7 additions & 0 deletions package/doc/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,17 @@
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
# NOTE: This sitemap is only correct for the release doccs. The development docs
# are served from https://www.mdanalysis.org/mdanalysis/ and the sitemap.xml
# will NOT be correct for the development docs.
site_url = "https://www.mdanalysis.org/docs/"

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand Down

0 comments on commit 2758574

Please sign in to comment.