-
Notifications
You must be signed in to change notification settings - Fork 103
[DOCS] Eliminate docs warnings #841
Copy link
Copy link
Open
Labels
Documentation 📚Changes to docstrings or the documentation site. No codebase changes.Changes to docstrings or the documentation site. No codebase changes.Effort > Moderate 🐕Mid-sized tasks estimated to take a few days to a few weeks.Mid-sized tasks estimated to take a few days to a few weeks.Impact > Moderate 🔶User-visible but non-breaking change. Treated like a minor version bump (e.g., 0.6.5 → 0.7.0).User-visible but non-breaking change. Treated like a minor version bump (e.g., 0.6.5 → 0.7.0).
Milestone
Description
Metadata
Metadata
Assignees
Labels
Documentation 📚Changes to docstrings or the documentation site. No codebase changes.Changes to docstrings or the documentation site. No codebase changes.Effort > Moderate 🐕Mid-sized tasks estimated to take a few days to a few weeks.Mid-sized tasks estimated to take a few days to a few weeks.Impact > Moderate 🔶User-visible but non-breaking change. Treated like a minor version bump (e.g., 0.6.5 → 0.7.0).User-visible but non-breaking change. Treated like a minor version bump (e.g., 0.6.5 → 0.7.0).
Type
Fields
Give feedbackNo fields configured for Bug.
Projects
Status
Backlog
Are you on the latest chainladder version?
Describe the bug in words
Continuing with the theme of tech debt cleanup for the 1.0 release. There are lots of warnings issued when building the docs. I don't think there are quite as many as there are for #840, so I think this could be a 1-person job, but feel free to create sub-issues if you think the scope will require multiple PRs.
How can the bug be reproduced?
Run
jb build .on a clean docs folder (make sure the_buildfolder is deleted before you run.)What is the expected behavior?
There should be 0 warnings. I don't think we need to make room for weird irreconcilable edge cases. If certain docs files aren't assigned to toctrees because they're still in-progress, we should move them to experimental forks.