Try to do some improvements in the docs. #137
Open
radnvlad wants to merge 2 commits intotock:masterfrom
Open
Conversation
Mkdocs apparently change the pages key to nav key. At least the latest version I got would revuse to build. Added some more info on how to build the documentation kind of suggesting we do this in the venv. On ubuntu at least the environment is manged by the OS, so you can't install without some amount or risk an the console yelling at you. Probably the location I added this is not optimal, but I'm open to suggestions. Added the .venv to gitignore.
… in the repo at all. So I removed them.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Mkdocs apparently changed the pages key to nav key. At least the latest version I used to build. Without the new key, I could not build. I did not attempt using al older version, but you probably would use to build the latest version.
Added some more info on how to build the documentation saying to do this in the venv. On ubuntu at least the environment is manged by the OS, so you can't install without some amount or risk and the console yelling at you. Probably the location I added this is not optimal, but I'm open to suggestions.
Added the .venv to gitignore.
The .md file are build artefacts. They probably should not be checked in the repo at all. So I removed them. And ignored them at the docs folder level.