https://github.com/andreasfertig/andreasfertig.github.io

C++ Insights - Documentation
https://github.com/andreasfertig/andreasfertig.github.io

Last synced: 6 months ago
JSON representation

C++ Insights - Documentation

• Host: GitHub
• URL: https://github.com/andreasfertig/andreasfertig.github.io
• Owner: andreasfertig
• Created: 2018-08-31T18:27:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-06-25T17:46:53.000Z (7 months ago)
• Last Synced: 2025-06-25T18:41:34.853Z (7 months ago)
• Language: CSS
• Size: 92.4 MB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme_docs.html
  • Contributing: contributing.html
  • Code of conduct: code_of_conduct.html

Awesome Lists containing this project

README

          


C++ Insights: C++ Insights - docs





    

        


            


        

    



/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */

$(function() {

  initMenu('',false,false,'search.php','Search');

});

/* @license-end */









  
C++ Insights - docs







This folder contains files used to generate the documentation which is available at docs.cppinsights.io. Doxygen is used to generate the documentation.

The documentation can be created with cmake:



cmake --build . --target doc



There are some pre- and post-processing steps involved.





Pre-processing





OptionDocumentationGenerator.cpp is compiled and executed. It parses InsightsOptions.def to generate a list of all C++ Insights options including the help text and the default. For each option there must be a example C++ file in examples. This file is included in help.



OptionDocumentationGenerator.py uses the previously generated markdown files and execute the C++ Insights binary for each sample source file and includes the transformation result in the help file as well.







Post-processing

Post-processing is done by postProcessDoxygen.py:



Add target="_blank" for each external link in the generated HTML output.

Remove unnecessary HTML files. For example, for each markdown file a File Reference file is created but empty.

For the remaining HTML files generate a sitemap.xml such that search engines can index docs.cppinsights.io properly. 











Generated by   1.9.8