Reputation: 11
How to Automatically Generate Documentation for ReadMe's from Multiple Repositories
I want to automatically generate a documentation site that contains the ReadMe's from all the repositories within my project. I am a little new to GitHub, so I'm not sure if my terminology is correct. I provide the link to the GitHub page that has all of the repositories.
I was wondering if there is any way to have a website that automatically generates documentation for all the ReadMe's found in any of the repositories. Ideally, this would be a website that recognizes if the ReadMe's were edited or if a new repository was made, and then automatically update the documentation for the website.
I have been looking at mkdocs and Sphinx, but I was wondering if there was an easy way to automatically generate and update documentation based on the ReadMe's from these repositories. As far as I know, these tools would not automatically update the website.
Upvotes: 1
Views: 822
Answers (0)
Related Questions
- Is it possible to create docs for multiple packages within the same git repository with sphinx-apidoc?
- How to share a Sphinx documentation theme between multiple github repositories?
- Automatically Generating Documentation for All Python Package Contents
- Create single Sphinx documentation page on readthedocs.org from multiple Python repositories
- Combining Sphinx Autodoc with Manual documentation
- How to host multiple version of a Sphinx based documentation on GitHub?
- Automatically Generate GitHub Wiki Documentation from Python Docstrings
- Combine Sphinx documentation from several Projects
- using Sphinx's sphinx-apidoc utility to autogenerate documentation from python code
- Combining Sphinx documentation from multiple subprojects: Handling indices, syncing configuration, etc