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

Fix api reference in readthedoc #156

Merged
merged 23 commits into from
Dec 20, 2023
Merged

Fix api reference in readthedoc #156

merged 23 commits into from
Dec 20, 2023

Conversation

JeanMainguy
Copy link
Member

The API reference generated by sphinx-apidoc was missing in our ReadTheDocs-hosted documentation. This problem occurred because ppanggolin and all Python dependencies weren't installed during the documentation build process. For more details, refer to this Stack Overflow.

To fix the problem:

  • Added all Python dependencies in a specific category within the toml file.
  • Modified the installation process in .readthedocs.yaml to install ppanggolin with the documentation and Python dependencies.
  • Remove requirements.txt in docs folder as it was not used anymore
  • Added the API Reference to the TOC tree of the Dev documentation section.

Copy link
Member

@jpjarnoux jpjarnoux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good

@jpjarnoux jpjarnoux merged commit f5eadc7 into dev Dec 20, 2023
7 checks passed
@JeanMainguy JeanMainguy deleted the ref_api_in_doc branch January 9, 2024 15:23
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.

2 participants