ACCESS-NRI / ACCESS-Vis

Visualisation examples and resources, including open-source 3D vis for ACCESS-NRI releases
Apache License 2.0
1 stars 0 forks source link

Add readthedocs documentation #1

Closed rbeucher closed 1 month ago

rbeucher commented 1 month ago

We need to set up Readthedocs for this repository to host and manage the documentation online. This will make it easier to maintain and share the project documentation with users and developers.

Action Required:

Set up a Readthedocs integration for this repository. Ensure that the repository's documentation structure adheres to the Readthedocs formatting requirements. Configure automatic updates to the documentation upon changes to the main branch. Guidelines:

Please follow the detailed information and organizational guidelines provided here: Readthedocs Information and Guidelines

Additional Notes:

Ensure the documentation theme aligns with our ACCESS-NRI standards. Verify that the documentation is properly generated and hosted on Readthedocs. Update the repository's README to include a badge or link to the documentation once it's live.

rbeucher commented 1 month ago

Skeleton ready