MyShaarli/doc/md
nodiscc db1532214e
replace mkdocs with sphinx/myst-parser for HTML documentation generation
- fixes https://github.com/shaarli/Shaarli/issues/1451
- tools/.gitattributes: exclude doc/conf.py and doc/requirements.txt from zip exports
- tools/doc/sphinx: suppress myst.xref_missing warnings caused by https://github.com/executablebooks/MyST-Parser/issues/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, https://github.com/readthedocs/readthedocs.org/issues/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
2023-10-05 15:01:34 +02:00
..
dev replace mkdocs with sphinx/myst-parser for HTML documentation generation 2023-10-05 15:01:34 +02:00
images **General rewording, proof-reading, deduplication, shortening, reordering, simplification, cleanup/formatting/standardization** 2020-09-12 14:31:45 +02:00
Backup-and-restore.md trivial refine for messages 2021-08-22 21:58:52 +08:00
Community-and-related-software.md doc: community/related software/integration with other platforms: add link to shaarli debian package 2023-08-27 15:59:39 +02:00
Docker.md doc: move OCI images hosting to ghcr.io 2023-03-17 16:17:37 +01:00
index.md replace mkdocs with sphinx/myst-parser for HTML documentation generation 2023-10-05 15:01:34 +02:00
Installation.md doc: installation/tests: clarify build tools installation procedure 2022-04-06 19:29:35 +02:00
Plugins.md doc: fix mkdocs build warnings/relative links 2023-08-20 23:13:59 +02:00
REST-API.md doc: fix mkdocs build warnings/relative links 2023-08-20 23:13:59 +02:00
Reverse-proxy.md doc: fix mkdocs build warnings/relative links 2023-08-20 23:13:59 +02:00
Server-configuration.md doc: server configuration: add PHP 8.2 to PHP compatibility table 2023-09-21 12:48:23 +00:00
Shaarli-configuration.md doc: fix mkdocs build warnings/relative links 2023-08-20 23:13:59 +02:00
Troubleshooting.md doc: troubleshooting: add note to adjust proxy timeouts or PHP max execution time if encountering timeouts 2023-02-19 15:29:56 +01:00
Upgrade-and-migration.md doc: updagrde/migration: simplify permissions setup 2020-09-12 14:31:45 +02:00
Usage.md doc: improve docs on usage of OR operator in tags search 2023-05-21 20:27:12 +02:00