Skip to content

Update ANISE documentation #28

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 25, 2025
Merged

Update ANISE documentation #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb10285
Update ANISE documentation
ChristopherRabotin Jun 25, 2025
32edd44
Remove metadata block
ChristopherRabotin Jun 25, 2025
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@
1. Navigate to the relevant folder where the Python bindings are installed, e.g. `/home/$USER/Workspace/nyx-space/anise/anise-py`
2. Install `pdoc3` with pipx if not available yet: `pipx install pdoc3`
3. Run pdoc with the `--pdf` flag, which generates a markdown actually: `pdoc3 anise.astro --pdf > /home/$USER/Workspace/nyx-space/docs/docs/anise/reference/api/python/astro2.md`. Keep in mind that there are TWO `docs` folders here!
4. This will create a mostly ready Markdown, but you'll need to clean it up by removing all occurrence of ` {#id}` (search and replace with nothing) and then removing extra new lines with `sed`: `sed '/^$/N;/\n$/D' /home/$USER/Workspace/nyx-space/docs/docs/anise/reference/api/python/astro/index2.md > /home/$USER/Workspace/nyx-space/docs/docs/anise/reference/api/python/astro/index.md`. **Importantly**, you must specify a different output than input or the file will be empty.
4. This will create a mostly ready Markdown, but remove extra new lines with `sed`: `sed '/^$/N;/\n$/D' /home/$USER/Workspace/nyx-space/docs/docs/anise/reference/api/python/astro/index2.md > /home/$USER/Workspace/nyx-space/docs/docs/anise/reference/api/python/astro/index.md`. **Importantly**, you must specify a different output than input or the file will be empty.

A few manual edits are typically required. Check on the staging server first.
A few manual edits are typically required. Check on the staging server first.
Loading