Closed ru-fu closed 5 months ago
You may want to check out this WIP branch - I put all the build related stuff in a different directory to the source files - it just takes a few tweaks to the various config files and the makefile https://github.com/evilnick/k8s-snap/tree/evildocs/docs The idea was that it makes it easier for contributors (internal or external) who can then easily find and work on the actual docs source and also it is IMO a good idea to separate out the docs themselves from the tools used to build them making it much easier to change/update/maintain the latter
Does this actually work on RTD? This has usually been the limiting factor.
And overall, I really don't want to do big changes and a restructuring of files at the moment, since we are planning to move most of the starter pack files to an extension. Anything we do before that will make that work harder, and it will also require existing users to update their copies multiple times instead of just once.
I haven't been able to test on rtd yet, but will confirm when I set it up. I am not saying this is what it should look like, just that it worked around some issues I had with team participation
The idea is that all files that are not needed to actively work with the documentation are either hidden files or in a hidden folder. For some, this isn't possible (for example, the
conf.py
file or the Makefile), but we should do it for all others.Check if we can hide
build_requirements.py
andpa11y.json
, and maybe the 404 files.