aeon
aeon copied to clipboard
[DOC] Write local documentation developer guide.
Write steps to build documentation locally.
Thank you for contributing to aeon
I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ].
The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.
If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.
Don't hesitate to ask questions on the aeon Slack channel if you have any.
PR CI actions
These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.
- [ ] Run
pre-commitchecks for all files - [ ] Run all
pytesttests and configurations - [ ] Run all notebook example tests
- [ ] Run numba-disabled
codecovtests - [ ] Stop automatic
pre-commitfixes (always disabled for drafts) - [ ] Push an empty commit to re-run CI checks
Mind if i make changes to this? Quite a bit that can be improved on this page IMO.
@MatthewMiddlehurst Yes sure, were you able to build the docs?
@MatthewMiddlehurst Oh, Okay! I build my docs in the way I wrote and have written this as per my experience. However, if this works, it would be much simpler. :))
Could you please edit accordingly?
absorbed into #2297. Includes your commit so you should still get credit
@all-contributors add @aadya940 for docs
@MatthewMiddlehurst
@aadya940 already contributed before to doc