add sitemap.xml to sphinx docs #1890
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
richardjgowers
approved these changes
May 7, 2018
|
rebased against develop, will merge/rebase after statuses. |
|
@richardjgowers I decided to generated sitemap.xml for the develop site so that we are guaranteed to have an appropriate sitemap.xml when deploying from travis. We deploy the master docs manually anyway so I added the new The script is doing a search and replace on the XML tree. A simple |
- 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
…ment - sitemap.xml is appropriate for the development docs: thus we do not ship and install a sitemap.xml that is misleading (when installing automatically via Travis CI) - change the loc in the sitemap.xml with the new maintainer/adapt_sitemap.py script: parse XML tree and replace the developer site URL prefix with the release doc prefix - manually create the release docs from master with the maintainer/deploy_master_docs.sh script (which is now calling the adapt_sitemap.py script)
|
rebased because of #1892 |
richardjgowers
approved these changes
May 7, 2018
|
I manually ran the doc building for master (with the new sitemap stuff temporarily patched in) and pushed new release docs for 0.18.0 that also contain a sitemap https://www.mdanalysis.org/docs/sitemap.xml |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(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)