docs: change sphinx theme to Clarity - #995
Open
liborjelinek wants to merge 3 commits into
Open
liborjelinek wants to merge 3 commits into
liborjelinek wants to merge 3 commits into
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
Copy link
Copy Markdown
Author
|
Because I introduced the first external dependency (the theme itself 😄), I had to change the HTML build step. But we now have an egg-chicken problem here. The theme requires a different structure for versions.json (changes to lsver.go are already in PR), but the updated JSON must be available at https://docs.syncthing.net/versions.json to successfully build HTML. Which is obviously not now, and thus this PR build is failing. |
Sorry, something went wrong.
Copy link
Copy Markdown
Author
|
@tomasz1986 or @imsodin will you help me here with the versions.json structure change? |
Sorry, something went wrong.
This branch has not been deployed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I am proposing a new theme for documentation. This is a follow-up and closes #991. It includes the "Edit on GitHub" link and the version select dropdown.
The Clarity theme already has built-in support for version selection. It is less visually intrusive than today's banner
It is also JS-free because the version list is validated and prepared during the Sphinx build. It allowed me remove former JS and legacy jQuery.
I also explicitly list dependencies in requirements.txt (only Sphinx and Clarity theme).
Lastly, I have changed lsver.go script a bit to conform Clarity theme's expected structure (changed sort order (oldest→latest becomes latest→oldest) and changed output from {"entries": [...]} to an array of {"version": "..."} objects.
You can preview it at https://showcase.readcraft.io/syncthing/. But keep in mind that version selection doesn't work because, for faster working, I am deploying to the showcase website only the latest version's files.