aeon icon indicating copy to clipboard operation
aeon copied to clipboard

[DOC] Write local documentation developer guide.

Open aadya940 opened this issue 1 year ago • 5 comments

Write steps to build documentation locally.

aadya940 avatar Aug 04 '24 16:08 aadya940

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-commit checks for all files
  • [ ] Run all pytest tests and configurations
  • [ ] Run all notebook example tests
  • [ ] Run numba-disabled codecov tests
  • [ ] Stop automatic pre-commit fixes (always disabled for drafts)
  • [ ] Push an empty commit to re-run CI checks

aeon-actions-bot[bot] avatar Aug 04 '24 16:08 aeon-actions-bot[bot]

Mind if i make changes to this? Quite a bit that can be improved on this page IMO.

MatthewMiddlehurst avatar Aug 07 '24 10:08 MatthewMiddlehurst

@MatthewMiddlehurst Yes sure, were you able to build the docs?

aadya940 avatar Aug 07 '24 10:08 aadya940

@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. :))

aadya940 avatar Aug 07 '24 14:08 aadya940

Could you please edit accordingly?

aadya940 avatar Aug 07 '24 14:08 aadya940

absorbed into #2297. Includes your commit so you should still get credit

MatthewMiddlehurst avatar Nov 04 '24 17:11 MatthewMiddlehurst

@all-contributors add @aadya940 for docs

MatthewMiddlehurst avatar Nov 04 '24 17:11 MatthewMiddlehurst

@MatthewMiddlehurst

@aadya940 already contributed before to doc

allcontributors[bot] avatar Nov 04 '24 17:11 allcontributors[bot]