This PR enables Sphinx Auto-API to create documentation that can later be pushed to Readthedocs. The documentation is incomplete; only automatic creation has been implemented.
This PR will close Issue #3, despite the fact that not all its functionality is included. New issues have already been created that should realise the remaining functionality.
Type of change
[X] New feature (non-breaking change which adds functionality)
Checklist:
[X] My code follows the style guidelines of this project
[X] I have performed a self-review of my code
[X] I have commented my code, particularly in hard-to-understand areas
[X] I have made corresponding changes to the documentation
[X] My changes generate no new warnings
[X] I have added tests that prove my fix is effective or that my feature works -- no tests required
[X] New and existing tests pass locally with my changes
[X] Any dependent changes have been merged and published in downstream modules
Description
This PR enables Sphinx Auto-API to create documentation that can later be pushed to Readthedocs. The documentation is incomplete; only automatic creation has been implemented.
This PR will close Issue #3, despite the fact that not all its functionality is included. New issues have already been created that should realise the remaining functionality.
Type of change
Checklist: