Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP replace mkdocs with sphinx/myst-parser for HTML documentation generation #17

Closed
wants to merge 18 commits into from

Conversation

nodiscc
Copy link
Owner

@nodiscc nodiscc commented Sep 15, 2023

- 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
- remove apache 2.2 configuration (2.4 was released in 2012)
- checked with python -m sphinx -b linkcheck -c doc doc/md doc/linkcheck
@nodiscc
Copy link
Owner Author

nodiscc commented Oct 5, 2023

Moved to shaarli#2025

@nodiscc nodiscc closed this Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant