10000 add docs · yalcin09/matplotlib-cpp@ccab4e9 · GitHub
[go: up one dir, main page]

Skip to content

Commit ccab4e9

Browse files
committed
add docs
1 parent 739d8bd commit ccab4e9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+18731
-0
lines changed

docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/doctrees/docs.doctree

8.39 KB
Binary file not shown.
13.5 KB
Binary file not shown.

docs/build/doctrees/index.doctree

5.81 KB
Binary file not shown.

docs/build/doctrees/license.doctree

6.97 KB
Binary file not shown.

docs/build/html/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: f17780a89409cffd51ea641f47a0b890
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/docs.rst.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _docs:
2+
3+
The Docs
4+
********
5+
6+
.. function:: format_exception(etype, value, tb[, limit=None])
7+
8+
Format the exception with a traceback.
9+
10+
:param etype: exception type
11+
:param value: exception value
12+
:param tb: traceback object
13+
:param limit: maximum number of stack frames to show
14+
:type limit: integer or None
15+
:rtype: list of strings
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. Matplotlib for C++ documentation master file, created by
2+
sphinx-quickstart on Thu Jul 18 20:49:11 2019.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Home
7+
****
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Content
12+
13+
docs
14+
license
15+
16+
Installation
17+
============
18+
19+
The Docs
20+
========
21+
See :ref:`docs`.
22+
23+
24+
H3 -- Subsection
25+
----------------
26+
27+
H4 -- Subsubsection
28+
+++++++++++++++++++
29+
30+
.. warning::
31+
32+
Never do this!
33+
34+
.. note::
35+
36+
Run you clever boy...
37+
38+
.. seealso::
39+
40+
... and remember.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _license:
2+
3+
License
4+
=======
5+
6+
The MIT License (MIT)
7+
8+
Copyright (c) 2014 Benno Evers
9+
10+
Permission is hereby granted, free of charge, to any person obtaining a copy
11+
of this software and associated documentation files (the "Software"), to deal
12+
in the Software without restriction, including without limitation the rights
13+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14+
copies of the Software, and to permit persons to whom the Software is
15+
furnished to do so, subject to the following conditions:
16+
17+
The above copyright notice and this permission notice shall be included in all
18+
copies or substantial portions of the Software.
19+
20+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26+
SOFTWARE.
27+
28+
Questions
29+
*********
30+
See here https://github.com/Cryoris/matplotlib-cpp for the fork this
31+
documentation is based on, or https://github.com/lava/matplotlib-cpp
32+
for the parent repository.
673 Bytes
Loading

0 commit comments

Comments
 (0)
0