Docs: clean build to update & purge superfluous JS etc. #34
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.
Follow-on to #33 where I committed the cf-plot documentation source with generated content pre-built by Andy Heaps, where I have made some tweaks so I (or indeed, anyone) can generate it locally with my
conda
environment and then re-built the documentation, in doing so picking out files which don't need to be included in the repo (mostly Javascript files for the theming underdocs/bulid/_static
and now apparently unused images underdocs/_images
.We shouldn't generally re-build the documentation until release-time, but this is important to ensure the source and the built content are in sync, ready for updates. I have tested that this all looks as it should from my local fork of the repo using GitHub Pages.
Also included in the this PR (see also individual commit descriptions), since they were necessary for the build and/or as updates e.g. to account the new docs home under NCAS-CMS:
setup.py
to refer to the new README and not break on looking for the oldREADME.txt
;Direct follow-on work identified