-
== Cppreference source package
- standard library reference documentation
- allows
- build the Cppreference C++'s offline archive
- if there is NO reference/ subdirectory -> actual documentation MUST be obtained separately
- build the Cppreference C++'s offline archive
-
ways to obtain the documentation
- download the archive | here
- recommended one
- Problems:
- Problem1: OLD versions
- Solution: TODO:
- Problem1: OLD versions
make source- Problems:
- Problem1: "bash: wget: command not found"
- Solution:
brew install wget
- Solution:
- Problem1: "bash: wget: command not found"
- pull the documentation directly -- from the -- website page-by-page
- ONLY take in account if there's NEW release | Archives
- if the layout of the website has changed since the last release -> the download script might NOT work
- supported documentation formats (
make allgenerate ALL)- Plain html documentation
- generated -- via --
make doc_html - The result of the transformation will be placed at the 'output/reference' subdirectory
- generated -- via --
- Devhelp documentation format
- generated -- via --
make doc_devhelp make installinstalls the documentation | proper locations
- generated -- via --
- QT Help documentation format (.qch)
- generated -- via --
make doc_qch make installinstalls the documentation | proper locations
- generated -- via --
- 💡Markdown format💡
- steps
make sourcepip3 install beautifulsoup4 html2textpython3 html_to_md.py- generate ⭐️reference_to_md⭐️
⚠️ NEXT executions will generate reference_to_md_new/⚠️ - Reason:🧠I take notes | reference_to_md🧠
- steps
- Plain html documentation
- Problems:
- download the archive | here
-
make release- generate the release archives / are uploaded | Archives
- ⭐️here⭐️
diff -r reference_to_md/ reference_to_md_new/