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

Docs commands #104

Merged
merged 2 commits into from
Jul 19, 2024
Merged

Docs commands #104

merged 2 commits into from
Jul 19, 2024

Conversation

ManuelHu
Copy link
Collaborator

@ManuelHu ManuelHu commented Jul 19, 2024

currently this is not automatically updated after a change in remage. RTD does not have a compiled version of remage available, so this can also not be easily added.

To manually recreate the command docs, one can use:

cd build
make remage-doc-dump
./src/remage-doc-dump doc
cd ../docs
./g4manual2rst.py ../build/man/rmg-manual.txt

partially fixes #6

@ManuelHu ManuelHu force-pushed the docs-commands branch 2 times, most recently from f861fec to 9bdad2f Compare July 19, 2024 22:23
currently this is not automatically updated after a change in remage.
RTD does not have a compiled version of remage available, so this can
also not be easily added.

To manually recreate the command docs, one can use:
```
cd build
make remage-doc-dump
./src/remage-doc-dump doc
cd ../docs
./g4manual2rst.py ../build/man/rmg-manual.txt
```
@ManuelHu ManuelHu merged commit 00258f2 into legend-exp:main Jul 19, 2024
5 of 6 checks passed
@ManuelHu ManuelHu deleted the docs-commands branch July 19, 2024 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Project documentation
1 participant