Try to do some improvements in the docs. #137
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.
|
@brghena I think the docs can be somewhat improved here, this is mostly a initial proposal, I'm open to doing some leg work here, but I'm curious what is your take on it. |
|
I thought we needed to have the docs built and committed to show up here: https://tockloader.readthedocs.io/en/latest/ Admittedly I set this up a long time ago and haven't looked at it since then really. |
|
Ah, I was not aware of this. I never worked with readthedocs, but it seems that it can build the artifacts itself OR it can use the cached one. Since we don't seem to have a config file for readthe docs, the build fails and then the cached files are used. You can see the failure here: https://app.readthedocs.org/projects/tockloader/builds/23212651/ I would go this way:
Or, just update them manually. But the generated files are currently stale, not by a lot, but you'll see diferences in gen vs current. I can do this, @bradjc but just tell me if you think this is useful. If not, I'll drop it, but it does feel like this is stale atm. |
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.