bit-team / backintime

Back In Time - An easy-to-use backup tool for GNU Linux using rsync in the back
https://backintime.readthedocs.io
GNU General Public License v2.0
2.03k stars 201 forks source link

Migrate user manual to MkDocs #1838

Open buhtz opened 1 month ago

buhtz commented 1 month ago

This is a meta issue to coordinate and document the steps migrating our documentation to MkDocs.

HowTo generate doc on your local system using MkDocs

To generate the doc on your local system, navigate into /doc/manual. Now you have to options: 1) Run mkdocs build to generate HTML and open /doc/manual/html/index.html, or 2) run mkdocs serve and start your browser with http://127.0.0.1:8000 ("localhost:8000" doesn't work on my system). You can modify the config and the content (md-files) life while the server runs.

buhtz commented 6 days ago

The user manual now is build with MkDocs by Read The Docs. The repo bit-team/doc now has a deprecated message in the beginning of it README.md and I set the repo into "archive" mode.

buhtz commented 5 days ago

https://mail.python.org/archives/list/bit-dev@python.org/message/JDU4EYFYKFA6YZZD2WP2WKPE4QA5UIBA/