Better directory listings #22
Description
Directory listings (eg. /, /src/) are horrible.
Here are a list of things I want to change:
- Merge
__init__.pyand the index into one rendered page. - Include a snippet of text from each child so the reader gets a summary of its contents.
- Sort directories before files.
Edit:
It should run as part of the rendering process. So when the user runs docc, the code should be executed.
Right now, __init__.py (eg. src/docc/__init__.py) and its parent directory (eg. src/docc/) are rendered as separate pages:
- https://samwilsn.github.io/docc/src/docc/index.html
- https://samwilsn.github.io/docc/src/docc/__init__.py.html
This leads to a less than optimal user experience. The directory listing pages have no useful content, and the __init__.py.html pages have no useful navigation. By merging these pages, the user can more naturally traverse the documentation website.