Built API docs from the docstrings using Sphinx+autodocs
Merged·Fixes:
This PR establishes an automated process for generating API documentation from Python docstrings for Brainglobe projects, starting with brainglobe-atlasapi, using Sphinx and its autodoc extensions.
fetch_external.py to clone or pull specified external Brainglobe repositories (e.g., brainglobe-atlasapi) into a local external/ directory.docs/source/conf.py) to include these fetched external repositories in sys.path and enabled sphinx.ext.autodoc, sphinx.ext.autosummary, and sphinx.ext.coverage extensions..rst) based API reference pages for brainglobe-atlasapi into the documentation, utilizing Sphinx's automodule directive to extract content from docstrings.fetch_external.py before the Sphinx build process.pip install command from fetch_external.py and the docs/source/documentation/test/index.rst file.brainglobe-atlasapi.autodoc and autosummary extensions to automatically parse Python docstrings and generate API reference.fetch_external.py for dynamic retrieval and updating of external project repositories, making their source code available for documentation.