Help
cancel
Showing results for 
Search instead for 
Did you mean: 
Ground Controller Lvl 1
Message 1 of 2

Documentation for 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.

https://github.com/casework

 

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. 

1 Reply
Commander Lvl 2
Message 2 of 2

Re: Documentation for Multiple Repositories

You may need to use the Github API to query your repositories, checking the status of Readme.md and fetching if new. Unless of course there's a tool that'll do that for you.

 

Please follow-up to let us know how you made out. For good karma, mark a reply as the answer if it helped!