Skip to content
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

[RFE] Auto generate documentation from directory contents #740

Open
black-dragon74 opened this issue May 31, 2022 · 1 comment
Open

[RFE] Auto generate documentation from directory contents #740

black-dragon74 opened this issue May 31, 2022 · 1 comment
Assignees

Comments

@black-dragon74
Copy link
Member

Instead of manually specifying the nav in mkdocs.yml we could autogenerate the nav links based on the directory structure.

The idea is to have a python script which does this automatically for us and then it calls the mkdocs build.

The result will be a cleaner mkdocs.yml file and to add any new section/content we will just have to create a markdown file under a directory.

Please share your thoughts.

/cc: @Shwetha-Acharya @kshithijiyer @aravindavk

@aravindavk
Copy link
Member

-1

Keeping the required order of the chapters is difficult if it is crawl based. Directories and file names should use number prefix so that order can be maintained (Ex: 002-Install-Guide/001-Overview.md). Reorganizing or introducing a chapter is very difficult(Imagine adding a chapter between 002-* and 003-*)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants