Is there any interest in extending the documentation? I've put together a more accessible documentation site for gallery-dl that I think could help users.
While the current documentation is thorough, the configuration.rst document is almost 8,000 lines and can be difficult to navigate. The community wiki has been helpful, but this project aims to combine both resources into a more accessible format.
What I have so far
- A Sphinx documentation site that preserves/combines all existing content
- Logical organization into sections like "Getting Started," "Guides," "Advanced Topics" and "Reference"
- Sphinx-immaterial provides improved navigation, search functionality, and per-page table of contents
- Modified
options.py and supportedsites.py scripts to output restructuredText
- Lots of document cross-referencing
I built the site with Sphinx using the sphinx-immaterial theme (following your lead with restructuredText). The GitHub Pages hosting can be maintained. There's also an actions workflow to deploy the site (will need some modification to integrate).
There's still some minor items to clean up and I have more I'd like to add, but it'll be ready for a PR within the next week or sooner. I think more eyes on it would clarify items that need attention. I'm attaching screenshots below to show the current implementation, and I'm open to any feedback or concerns you might have.
Is there any interest in extending the documentation? I've put together a more accessible documentation site for gallery-dl that I think could help users.
While the current documentation is thorough, the
configuration.rstdocument is almost 8,000 lines and can be difficult to navigate. The community wiki has been helpful, but this project aims to combine both resources into a more accessible format.What I have so far
options.pyandsupportedsites.pyscripts to output restructuredTextI built the site with Sphinx using the sphinx-immaterial theme (following your lead with restructuredText). The GitHub Pages hosting can be maintained. There's also an actions workflow to deploy the site (will need some modification to integrate).
There's still some minor items to clean up and I have more I'd like to add, but it'll be ready for a PR within the next week or sooner. I think more eyes on it would clarify items that need attention. I'm attaching screenshots below to show the current implementation, and I'm open to any feedback or concerns you might have.