Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

dancer1325/cppreference-doc

Open more actions menu
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

934 Commits
934 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Information

  • == 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
  • ways to obtain the documentation

    • download the archive | here
      • recommended one
      • Problems:
        • Problem1: OLD versions
          • Solution: TODO:
    • make source
      • Problems:
        • Problem1: "bash: wget: command not found"
          • Solution: brew install wget
      • 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 all generate ALL)
        1. Plain html documentation
          • generated -- via -- make doc_html
          • The result of the transformation will be placed at the 'output/reference' subdirectory
        2. Devhelp documentation format
          • generated -- via -- make doc_devhelp
          • make install installs the documentation | proper locations
        3. QT Help documentation format (.qch)
          • generated -- via -- make doc_qch
          • make install installs the documentation | proper locations
        4. 💡Markdown format💡
          • steps
            • make source
            • pip3 install beautifulsoup4 html2text
            • python3 html_to_md.py
          • ⚠️NEXT executions will generate reference_to_md_new/ ⚠️
  • make release

    • generate the release archives / are uploaded | Archives

Dependencies

Documentation -- to -- study

ways to compare changes | generate "reference_to_md_new/"?

way1

  • diff -r reference_to_md/ reference_to_md_new/

way2

About

C++ standard library reference

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 49.1%
  • C++ 18.6%
  • Python 13.4%
  • JavaScript 8.9%
  • CSS 6.7%
  • PHP 2.2%
  • Other 1.1%
Morty Proxy This is a proxified and sanitized view of the page, visit original site.