WIP replace mkdocs with sphinx/myst-parser for HTML documentation generation #17
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
Owner
nodiscc
commented
Sep 15, 2023
•
nodiscc
commented
- verify that it builds locally
- verify that it builds on readthedocs https://readthedocs.org/projects/shaarli-test/builds/, https://shaarli-test.readthedocs.io/en/latest/
nodiscc
force-pushed
the
doc-sphinx
branch
4 times, most recently
from
51b6881
to
e5d2558
Compare
- fixes shaarli#1451 - tools/.gitattributes: exclude doc/conf.py and doc/requirements.txt from zip exports - tools/doc/sphinx: suppress myst.xref_missing warnings caused by executablebooks/MyST-Parser#564 - dockerfile: use makefile/sphinx instead of mkdocs to build HTML documentation - dockerfile: add bash to the docs build container (make: bash: No such file or directory) - tools/doc/readthedocs: force use of python 3.11 (readthedocs ERROR: No matching distribution found for sphinx==7.1.0) - tools/doc/readthedocs: add all required configuration variables https://docs.readthedocs.io/en/latest/config-file/v2.html#build-os - tools/doc/readthedocs: override build commands to allow the source directory to be different from the conf.py directory (https://docs.readthedocs.io/en/stable/config-file/v2.html#build-commands, readthedocs/readthedocs.org#1543) - tools/doc/readthedocs: manually set output directory (readthedocs ERROR: No _readthedocs/html folder was created during this build.) - doc: replace all references to mkdocs with sphinx
…lopment page - add the Development page to the main TOC
- remove json syntax highlighting from invalid json block - fix warning about unknown lexer `conf` - fix syntax highlighting for example htaccess
- ref. shaarli#2002 - uses old instructions/mod-php instead of the now recommended php-fpm - server configuration may not be the ideal page for this, installation would be more suitable
…(since 2014/2015)
…HTML documentation
- remove apache 2.2 configuration (2.4 was released in 2012)
- checked with python -m sphinx -b linkcheck -c doc doc/md doc/linkcheck
|
Moved to shaarli#2025 |
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.