Interactive graphs and charts for C++ 11 upward, viewable in-browser using cpplot-viewer.
Full documentation is at https://cpplot.readthedocs.io
You should only need to read the following if you plan to develop on cpplot.
We use the Google C++ style guide with the following exceptions:
- Don't care about line width so long as its within reason
- Use 4 space indenting, not 2 as suggested by the style guide, because we're not total monsters (just kidding xx).
You need to install pre-commit to get the hooks working. Do:
pip install pre-commit
pre-commit install
Once that's done, each time you make a commit, the following checks are made:
- valid github repo and files
- code style
- documentation builds correctly
Upon failure, the commit will halt. Re-running the commit will automatically fix most issues except:
- You'll have to fix documentation yourself prior to a successful commit (there's no auto fix for that!!).
You can run pre-commit hooks without making a commit, like:
pre-commit run build-docs
which is useful to locally build documents without crazy efforts setting up an environment for sphinx.
A cross-platform compilation file is provided using cmake, but it's not tested on windows.
PRs to fix or improve it for windows are most welcome.