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
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion docs/developer_guide/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


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