-
Notifications
You must be signed in to change notification settings - Fork 176
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
doc: Initial MkDocs (material theme) setup for BIT manual #1738
base: dev
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to merge the PR to work further on several documentation issues and testing to adapt the readthedocs profile to mkdocs.
I see no potential for harm to the original code base because there are no code files modified.
If there is no veto in the next days I will merge and hope it is OK this way.
EDIT: Because of our internal discussion about the next release I'll wait with merging until the upcoming release.
This is a first MkDocs setup using the material theme. It is living only in this repo and is not yet configured in ReadTheDocs.
As a basis I used the MkDocs setup provided in #1659 by Kosta Vukicevic (stcksmsh). I minimized it as much as possible, investigated the plugins/extensions and tried to document them in the mkdocs.yml config file with comments.
The content of the manual is not modified. It is nearly the same as the current one generated by our Sphinx setup.
I reduce the file size of the screenshot images by ~13% using
optipng
.I created the folder
/doc/manual
in the repo for BIT's user manual. In the future I would create the code reference docu in something like/doc/reference
or/doc/coderef
.Next task in follow-up PRs are:
To generate the doc on your local system, navigate into
/doc/manual
. Now you have to options: 1) Runmkdocs build
to generate HTML and open/doc/manual/html/index.html
, or 2) runmkdocs 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.Did I forget something?
❤️ I love it as much as I work with it. ❤️