-
Notifications
You must be signed in to change notification settings - Fork 3
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
docs: Initial docs and JupyterBook setup #66
Conversation
Here's the code health analysis summary for commits Analysis Summary
|
Looks like the build is failing |
Are you able to see the build logs btw? |
Yes I can see the RTD previews and the log outputs. Somehow |
This is because RTD is not using pixi toml to actually install anything, you'll have to modify the |
See readthedocs/readthedocs.org#11548 (comment) for related conversation about this |
Thanks for the help @lsetiawan! |
No problem! Thanks for setting it up! 😄 |
Good to know we can use pixi to setup jupyterbook! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Quality Gate passedIssues Measures |
This pull request includes several changes to improve the documentation setup and configuration for the
phylo2vec
project. The changes include adding configuration files for Read the Docs and Jupyter Book, updating the table of contents and API reference, and adding necessary dependencies.Documentation setup and configuration:
.readthedocs.yaml
: Added a configuration file for Read the Docs to specify the build environment and tools required for generating documentation.docs/_config.yml
: Added a configuration file for Jupyter Book to set book settings, execution options, repository information, and Sphinx extensions.docs/_toc.yml
: Added a table of contents file for Jupyter Book to define the structure of the documentation.docs/api.rst
: Added an API reference file to document the functions and modules in thephylo2vec
project using Sphinx autosummary.docs/requirements.txt
: Added a requirement forjupyter-book
to ensure the necessary dependencies are installed.Additionally, the
pixi.toml
file was updated to include a task for building the documentation using Jupyter Book:pixi.toml
: Added abuild-docs
task to thefeature.python.tasks
section to automate the documentation build process.Related Issues
Closes #44
Closes #43
Closes #42