Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
extended and restructured documentation, with a lot of side effects
- Loading branch information
Showing
25 changed files
with
1,987 additions
and
1,911 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
![](pytikz.png) | ||
![](logo.png) | ||
|
||
|
||
# pytikz – A Python interface to Ti*k*Z | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 018cb767d2d680826122426e1460dd18 | ||
config: 8201efeec50362c507fb6cfe61a14c3c | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,24 @@ | ||
.. pytikz documentation master file, created by | ||
sphinx-quickstart on Mon Jul 6 23:27:44 2020. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
pytikz | ||
====== | ||
|
||
.. automodule:: tikz | ||
:members: | ||
.. Inform Sphinx about what is part of the documentation, without listing all | ||
the document's TOCs here. Some weird contortions are necessary to do a | ||
simple thing! | ||
.. toctree:: | ||
:maxdepth: 1 | ||
:hidden: | ||
|
||
index | ||
tikz | ||
|
||
|
||
This package provides a way to create, compile, view, and save graphics based on the LaTeX package `TikZ & PGF <https://ctan.org/pkg/pgf>`_. It makes | ||
the creation of TikZ graphics easier when (part of) the underlying data is computed, and makes the preview and debugging of graphics within a Jupyter | ||
notebook seamless. | ||
|
||
This documentation explains only how to access TikZ' functionality from Python; to use it effectively, the `TikZ & PGF manual <https://pgf-tikz.github.io/pgf/pgfmanual.pdf>`_ needs to be consulted. A `notebook <https://nbviewer.jupyter.org/github/allefeld/pytikz/blob/master/pytikz.ipynb>`_ contains examples to get you started. | ||
|
||
---- | ||
|
||
All functionality is contained in the module :py:mod:`tikz`. At its center is | ||
the class :py:class:`tikz.Picture`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
tikz package | ||
============ | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: tikz | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Oops, something went wrong.