Skip to content

Commit

Permalink
extended and restructured documentation, with a lot of side effects
Browse files Browse the repository at this point in the history
  • Loading branch information
allefeld committed Jul 8, 2020
1 parent 7883ac8 commit b0584f9
Show file tree
Hide file tree
Showing 25 changed files with 1,987 additions and 1,911 deletions.
2 changes: 1 addition & 1 deletion README.md
@@ -1,4 +1,4 @@
![](pytikz.png)
![](logo.png)


# pytikz – A Python interface to Ti*k*Z
Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
@@ -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
29 changes: 23 additions & 6 deletions docs/_sources/index.rst.txt
@@ -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`.
10 changes: 10 additions & 0 deletions docs/_sources/tikz.rst.txt
@@ -0,0 +1,10 @@
tikz package
============

Module contents
---------------

.. automodule:: tikz
:members:
:undoc-members:
:show-inheritance:

0 comments on commit b0584f9

Please sign in to comment.