Migrate docs to mkdocs #12
Conversation
Signed-off-by: Pawel Langowski <[email protected]>
| @@ -110,18 +110,11 @@ to generate detailed code documentation automatically. | |||
| To generate the documentation run the following: | |||
|
|
|||
| ```bash | |||
| (venv) make html | |||
| (venv) mkdocs serve | |||
| python -m http.server 8000 | |||
There was a problem hiding this comment.
mkdocs serve already starts http server, so below python command should not be necessary anymore
There was a problem hiding this comment.
@PLangowski do you plan to address this?
|
Comparing the overall look and feel Before: After:
In my opinion it looks so much worse... It was @macpijan idea/request to migrate to mkdocs: #5 (comment) so maybe he can review as well. |
|
@miczyg1 I agree, it's much less readable. |
|
@macpijan Have you looked at this? |
|
@macpijan we would like to have the release by the end of the week. We would appreciate your review and opinion about mkdocs vs sphinix. I would also prefer mkdocs, but the question is how to make it look reasonable. |
Have you researched alternative themes or mkdocs @PLangowski ? |
No description provided.