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

[DOC] Write local documentation developer guide. #1905

Closed
wants to merge 1 commit into from

Conversation

aadya940
Copy link
Contributor

@aadya940 aadya940 commented Aug 4, 2024

Write steps to build documentation locally.

@aeon-actions-bot aeon-actions-bot bot added the documentation Improvements or additions to documentation label Aug 4, 2024
@aeon-actions-bot
Copy link
Contributor

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

@MatthewMiddlehurst
Copy link
Member

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

@aadya940
Copy link
Contributor Author

aadya940 commented Aug 7, 2024

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

@@ -125,7 +125,26 @@ pip install .[docs]

```{code-block} powershell
cd docs
sphinx-apidoc -o docs/ ../
Copy link
Member

Choose a reason for hiding this comment

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

I dont think this is needed. The relevant files were created using the makefile/make.bat for me.

NOTES:
- This will auto-generate documentation by recursively travelling through the modules of `aeon` as static `.rst` files by parsing the docstrings. Hence, make sure your contribution is accessible through `__all__` if it exists.
- Whenever you write new documentation, for example a class, mention it in the `docs/api_reference`.
- Whenever you write new documentation, rerun `sphinx-apidoc` command after deleting the old generated files.
Copy link
Member

Choose a reason for hiding this comment

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

I also dont think this is needed, refreshing after a new make.bat html worked for me.

@aadya940
Copy link
Contributor Author

aadya940 commented Aug 7, 2024

@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
Copy link
Contributor Author

aadya940 commented Aug 7, 2024

Could you please edit accordingly?

@MatthewMiddlehurst
Copy link
Member

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

@MatthewMiddlehurst
Copy link
Member

@all-contributors add @aadya940 for docs

Copy link
Contributor

@MatthewMiddlehurst

@aadya940 already contributed before to doc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants