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

docs: Initial docs and JupyterBook setup #66

Merged
merged 11 commits into from
Dec 20, 2024
Merged

Conversation

ayushnag
Copy link

@ayushnag ayushnag commented Dec 19, 2024

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 the phylo2vec project using Sphinx autosummary.
  • docs/requirements.txt: Added a requirement for jupyter-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 a build-docs task to the feature.python.tasks section to automate the documentation build process.

Related Issues

Closes #44
Closes #43
Closes #42

Copy link

deepsource-io bot commented Dec 19, 2024

Here's the code health analysis summary for commits ec18e9f..386f6ea. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Rust LogoRust✅ SuccessView Check ↗
DeepSource Python LogoPython✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@ayushnag ayushnag marked this pull request as ready for review December 19, 2024 20:07
@lsetiawan lsetiawan closed this Dec 19, 2024
@lsetiawan lsetiawan reopened this Dec 19, 2024
@lsetiawan
Copy link
Member

Looks like the build is failing

@lsetiawan
Copy link
Member

Are you able to see the build logs btw?

@ayushnag
Copy link
Author

Yes I can see the RTD previews and the log outputs. Somehow jupyter-book is not importing even though it's added to the pixi.toml. I'll take a look

@lsetiawan
Copy link
Member

This is because RTD is not using pixi toml to actually install anything, you'll have to modify the .readthedocs to make it so that pixi is used

@lsetiawan lsetiawan changed the title Initial docs and JupyterBook setup docs: Initial docs and JupyterBook setup Dec 19, 2024
@lsetiawan
Copy link
Member

See readthedocs/readthedocs.org#11548 (comment) for related conversation about this

.readthedocs.yaml Outdated Show resolved Hide resolved
pixi.toml Outdated Show resolved Hide resolved
@lsetiawan
Copy link
Member

@ayushnag It works now: https://uw-phylo2vec--66.org.readthedocs.build/en/66/

@ayushnag
Copy link
Author

Thanks for the help @lsetiawan!

@lsetiawan
Copy link
Member

No problem! Thanks for setting it up! 😄

@lsetiawan
Copy link
Member

Good to know we can use pixi to setup jupyterbook!

Copy link
Member

@lsetiawan lsetiawan left a comment

Choose a reason for hiding this comment

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

LGTM

docs/requirements.txt Outdated Show resolved Hide resolved
@lsetiawan lsetiawan merged commit b7c507a into uw-ssec:dev Dec 20, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants