/cppreference-doc

C++ standard library reference
  1. Python 33.9%
  2. JavaScript 31.4%
  3. CSS 23.5%
  4. PHP 7.9%
  5. Makefile 1.9%
  6. XSLT 1.0%
  7. Shell 0.4%
Python JavaScript CSS PHP Makefile XSLT Shell
Switch branches/tags
Nothing to show
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
commands Preprocess: rename fix_relative_link() to tranform_link() Mar 14, 2018
gadgets Gadgets/Coliru: Acquire Ace editor resources via https Mar 31, 2018
headers Headers: Fix definition of basic_ifstream Mar 20, 2018
images Update my email in the copyright headers Mar 30, 2014
index_transform Transform: Rename incorrectly named class Mar 1, 2018
misc Update my email in the copyright headers Mar 30, 2014
skins skins: Add common skins files Apr 9, 2017
tests Preprocess: split fix_relative_link() Mar 14, 2018
.gitignore gitignore: Ignore virtual environment paths Jan 1, 2018
Makefile Fix release build Apr 14, 2018
README.md Preprocess: Switch from XSLT to python for Qt help project generation Jun 6, 2017
build_link_map.py Fix building on LC_ALL=C locale Mar 25, 2017
ddg_parse_html.py Transform/DDG: Pass desc building parameters from command line Nov 18, 2016
devhelp2qch.py Preprocess: Switch from XSLT to python for Qt help project generation Jun 6, 2017
export.py Include the Mediawiki source into the distribution archive Apr 9, 2017
fix_devhelp-links.py Fix building on LC_ALL=C locale Mar 25, 2017
index-chapters-c.xml Update my email in the copyright headers Mar 30, 2014
index-chapters-cpp.xml Add index entries for the header pages on the wiki. Nov 15, 2016
index-cpp-search-app.txt Index: Add links to final and override concepts Oct 24, 2016
index-functions-c.xml Add timespec to index-functions-c.xml Nov 30, 2017
index-functions-cpp.xml Index: Fix namespace of std::experimental::filesystem::begin/end Oct 24, 2016
index-functions.README Index: Add 'experimental' option for since attribute Aug 8, 2015
index2autolinker.py Transform: Allow XML data to be transformed directly Mar 1, 2018
index2browser.py Transform: Allow XML data to be transformed directly Mar 1, 2018
index2ddg.py Transform: Allow XML data to be transformed directly Mar 1, 2018
index2devhelp.py Transform: Allow XML data to be transformed directly Mar 1, 2018
index2doxygen-tag.py Transform: Rename incorrectly named class Mar 1, 2018
index2highlight.py Transform: Allow XML data to be transformed directly Mar 1, 2018
index2search.py Transform: Allow XML data to be transformed directly Mar 1, 2018
link_map.py Fix building on LC_ALL=C locale Mar 25, 2017
preprocess-css.css Preprocess: add several css workaround rules Dec 4, 2012
preprocess.py Preproces: move reusable components to separate folder Mar 14, 2018
test.sh Add script to run tests Mar 14, 2018
xml_utils.py Preprocess: Fix filenames that contain special characters Jun 30, 2014

README.md

Information

This is source package for Cppreference C++ standard library reference documentation available at http://en.cppreference.com.

If there is no 'reference/' subdirectory in this package, the actual documentation is not present here and must be obtained separately in order to build the binary package. This can be done in two ways:

  1. Downloading a prepared archive from http://en.cppreference.com/w/Cppreference:Archives. This method is preferred.

  2. Running make source which will pull the documentation directly from the website page-by-page. You should not normally use this method. The download script is updated to take into account any changes of the website only when there's new release at http://en.cppreference.com/w/Cppreference:Archives. If the layout of the website has changed since the last release, the download script might not work. Also, it puts unnecessary load on the servers. Please do not use this method unless you know what you are doing.

Note, that abovementioned documentation is still a raw copy of the website and needs to be transformed in order to be suitable for local viewing. Three documentation formats are currently supported:

  1. Plain html documentation. Can be generated using make doc_html. The result of the transformation will be placed at the 'output/reference' subdirectory.

  2. Devhelp documentation format. Can be generated using make doc_devhelp. make install installs the documentation into proper locations.

  3. QT Help documentation format (.qch). Can be generated using make doc_qch. make install installs the documentation into proper locations.

Simply running make all will generate documentation in all three formats.

Running make release will generate the release archives which are uploaded to http://en.cppreference.com/w/Cppreference:Archives.

Dependencies

The package depends on 'wget' (>=1.15), 'python3', 'python3-lxml', and 'qhelpgenerator' for the generation of the documentation.

See also

Debian packaging information for this package is maintained at https://github.com/p12tic/cppreference-doc_debian