Skip to content

Commit 2120142

Browse files
Merge pull request #28 from nyx-space/update/2025-06-24
Update ANISE documentation
2 parents 9186170 + 32edd44 commit 2120142

File tree

9 files changed

+10779
-665
lines changed

9 files changed

+10779
-665
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414
1. Navigate to the relevant folder where the Python bindings are installed, e.g. `/home/$USER/Workspace/nyx-space/anise/anise-py`
1515
2. Install `pdoc3` with pipx if not available yet: `pipx install pdoc3`
1616
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!
17-
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.
17+
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.
1818

19-
A few manual edits are typically required. Check on the staging server first.
19+
A few manual edits are typically required. Check on the staging server first.

0 commit comments

Comments
 (0)