Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Config file for Read The Docs #179

Merged
merged 1 commit into from
Dec 5, 2024
Merged

Config file for Read The Docs #179

merged 1 commit into from
Dec 5, 2024

Conversation

wigging
Copy link
Collaborator

@wigging wigging commented Dec 5, 2024

This adds a configuration file to the docs/ directory for Read The Docs. When setting up the project on the Read The Docs website, the following need to be considered:

  • Set the path to the config file to docs/.readthedocs.yaml; otherwise, Read The Docs will look in the root directory of the project for the configuration
  • Set latest to the dev branch and stable to the main branch

This resolves #170 to make the documentation viewable online.

@wigging wigging self-assigned this Dec 5, 2024
@wigging wigging linked an issue Dec 5, 2024 that may be closed by this pull request
@renan-souza renan-souza merged commit 9af9af1 into dev Dec 5, 2024
5 checks passed
@renan-souza renan-souza deleted the readthedocs branch December 5, 2024 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sphinx Documentation is not available for users
2 participants