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

docs: add reference documentations #546

Draft

JohelEGP wants to merge 1 commit into mpusz:master from JohelEGP:ref_docs

Collaborator

JohelEGP commented Jan 20, 2024

Resolves #395.

This is a WIP for the reference documentations.
It's in a state that can build the PDF and HTML.
@mpusz Please, use this PR to test #532.

Instructions:

Checkout these repositories:
Satisfy the requirements:
- For the PDF, see the README: https://github.com/cplusplus/draft.
- For the HTML, see the README: https://github.com/Eelis/cxxdraft-htmlgen.
Consider https://github.com/JohelEGP/jegp.cmake_modules/blob/0df2908dfe83b1f95920d2b20d9436b8f8650498/README.md?plain=1#L107-L121.

Configure:

cmake -S docs/reference -B build/docs/reference \
 -DCMAKE_MODULE_PATH="<path to gh:JohelEGP/jegp.cmake_modules>/modules" \
 -DJEGP_STANDARDESE_SOURCES_GIT_REPOSITORY="<path to gh:JohelEGP/draft>" \
 -DJEGP_CXXDRAFT_HTMLGEN_GIT_REPOSITORY="<path to gh:JohelEGP/cxxdraft-htmlgen>"

Build as normal.
For the HTML, you may need to put mathjax-node-cli in PATH.


docs: add reference documentations

b7d0ba3

JohelEGP marked this pull request as draft

January 20, 2024 20:58

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment