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

Added nesting of sidebar items #752

Closed
wants to merge 5 commits into from

Conversation

Om-Doiphode
Copy link
Contributor

@Om-Doiphode Om-Doiphode commented Aug 16, 2024

Fixes issue #713

  • Changed the documentation theme from furo to pydata-sphinx-theme
  • Implemented nesting of menus and submenus in the Section Navigation.
  • Improved the overall structure and navigation of the documentation.
  • Ensured that all relevant sections are properly organized under their respective categories.

image
image
image
image

Copy link
Contributor

@henrykironde henrykironde left a comment

Choose a reason for hiding this comment

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

@Om-Doiphode, thank you for these changes. The documentation updates align well with what we discussed. However, I have a few suggestions:

It's standard practice to keep the source or api directories dedicated solely to API module documentation. This helps streamline maintenance when the source code is updated. The conf.py file should remain in the default location: docs/conf.py. I don't think we need the deepforest_docs folder. We can remove it, and all the subdirectories can be moved directly under docs/.

We still have some redundant parts like getting started appear twice, in the introduction and again as a main topic.

@henrykironde
Copy link
Contributor

Can you rebase with main

@henrykironde
Copy link
Contributor

Make this one commit. Amend the commits to one

@bw4sz
Copy link
Collaborator

bw4sz commented Aug 19, 2024

@Om-Doiphode Once you rebase, i'm excited to get this merged. Let us know if you need help.

Copy link
Contributor

@henrykironde henrykironde left a comment

Choose a reason for hiding this comment

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

Make one commit.
Make sure the tests pass. Look at the error message and see if you can figure out the reason why it is failing.

@@ -4,7 +4,8 @@ aiohttp
bumpversion
comet_ml
docformatter
furo
docutils<0.18
Copy link
Contributor

Choose a reason for hiding this comment

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

remove this dep, "docutils<0.18"

@henrykironde
Copy link
Contributor

@Om-Doiphode Use pytest --nbmake docs/**/*_test.ipynb to test specific notebooks. To exclude certain notebooks from CI/CD runs, ensure the ones you want to test end with _test.ipynb. This approach avoids running time-consuming notebooks that should be tested locally. Make sure when you run ls docs/**/*_test.ipynb locally, you retriever the files expected to be tested.

@bw4sz
Copy link
Collaborator

bw4sz commented Aug 21, 2024

@Om-Doiphode, rebase, there was another PR.

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.

3 participants