-
Notifications
You must be signed in to change notification settings - Fork 129
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
Conversation
Thank you for contributing to
|
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? |
@@ -125,7 +125,26 @@ pip install .[docs] | |||
|
|||
```{code-block} powershell | |||
cd docs | |||
sphinx-apidoc -o docs/ ../ |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
@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 |
@aadya940 already contributed before to doc |
Write steps to build documentation locally.