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.

Sign up for GitHub

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

Jump to bottom

Documentation upgrades #352

Merged
merged 7 commits into from
Sep 5, 2023
Merged

Documentation upgrades #352

merged 7 commits into from
Sep 5, 2023

Conversation

btjanaka
Copy link
Member

@btjanaka btjanaka commented Sep 3, 2023 •
edited
Loading

Description

A bunch of tiny errors and upgrades in the documentation.

TODO

  • Miscellaneous typos
  • Remove obsolete references to initialize method in CVTArchive
  • Make parallel_axes_plot take shorter to run — before, this example was taking very long to generate its plot
  • Rearrange tutorials page so that tutorials show up properly in the sidebar — this involved making the globaltoc depth be 3 in docs/conf.py
  • Add a features section on tutorials page — in the future, we plan to have a couple such tutorials
  • Update CONTRIBUTING for tutorials — added some new details
  • Don't wait to open browser when reloading docs with sphinx-autobuild
  • Note * syntax in constructor args — The * syntax to force keyword arguments can be confusing. We now include a note in the lunar lander tutorial about it.

Questions

Status

  • I have read the guidelines in CONTRIBUTING.md
  • I have formatted my code using yapf
  • I have tested my code by running pytest
  • I have linted my code with pylint
  • I have added a one-line description of my change to the changelog in HISTORY.md
  • This PR is ready to go

@btjanaka
Add pre-commit
2ffcf11
@btjanaka
Note pylint pre-commit skip
e483eed
@btjanaka
Clarify formatting instructions
8c4b617
@btjanaka
Revert license changes
d759355
@btjanaka
Skip LICENSE in pre-commit
f19506b
@btjanaka
Documentation fixes
1c2a7c6 
- Plural emitters
- Rearrange tutorials sidebar
- Don't wait to open browser when building docs
- Shorten parallel_axes_plot example
- Add section for feature tutorials
- Update tutorial test to include features
- Note different tutorial subdirs
- Note on tutorial links
- Add example feature tutorial
- Add note about keyword arguments
- Remove references to initialize in CVTArchive
@btjanaka btjanaka changed the title Miscellaneous documentation fixes Documentation upgrades Sep 3, 2023
@btjanaka btjanaka merged commit b411612 into master Sep 5, 2023
17 checks passed
@btjanaka btjanaka deleted the docs-fixes branch September 5, 2023 01:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@btjanaka