Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

ReadTheDocs Documentation

This repository holds a short study of how to build ReadTheDocs documentation and deploy it as a GitHub page. The reference I used is How to document your research software.

Content

The website is re-built whenever the branch gh-pages is updated. This occurs automatically on push on the branches documentation and documentation2 (via a GitHub Action). The branch documentation illustrates the use of the autodoc extension for auto-generating the API reference, whereas the branch documentation2 relies on the extension autodoc2.

About

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages