-
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -125,7 +125,26 @@ pip install .[docs] | |
|
||
```{code-block} powershell | ||
cd docs | ||
sphinx-apidoc -o docs/ ../ | ||
``` | ||
|
||
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 commentThe reason will be displayed to describe this comment to others. Learn more. I also dont think this is needed, refreshing after a new |
||
|
||
3. To make the documentation, run: | ||
|
||
```{code-block} powershell | ||
make html | ||
cd _build/html | ||
``` | ||
|
||
You may need to install pandoc to build the documentation locally. | ||
This will generate html documentation in `docs/_build/html`. Navigate to the `html` folder. | ||
|
||
4. To start an HTTP Server, run: | ||
|
||
```{code-block} powershell | ||
python -m http.server | ||
``` | ||
This will start an HTTP Server and your docs will be visible |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.