Skip to content

Commit

Permalink
Move manual ingredients all into one directory
Browse files Browse the repository at this point in the history
  • Loading branch information
lornajane committed Nov 18, 2018
1 parent 9814773 commit e9e497f
Show file tree
Hide file tree
Showing 10 changed files with 1,084 additions and 10 deletions.
File renamed without changes.
File renamed without changes.
Binary file added doc/manual/images/biohazard.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
1,063 changes: 1,063 additions & 0 deletions doc/manual/includes/flowables.py

Large diffs are not rendered by default.

File renamed without changes.
29 changes: 20 additions & 9 deletions doc/manual.rst → doc/manual/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ The user's file at ``~/.rst2pdf/config`` will have priority over the system's at
Here's an example file showing some of the currently available options:

.. code-block:: ini
:include: config.sample
:include: includes/config.sample
Pipe usage
==========
Expand Down Expand Up @@ -154,11 +154,11 @@ You can insert images in the middle of your text like this::

This |biohazard| means you have to run.

.. |biohazard| image:: ../rst2pdf/tests/input/images/biohazard.png
.. |biohazard| image:: images/biohazard.png

This |biohazard| means you have to run.

.. |biohazard| image:: ../rst2pdf/tests/input/images/biohazard.png
.. |biohazard| image:: images/biohazard.png

This only works correctly with reportlab 2.2 or later.

Expand Down Expand Up @@ -1074,14 +1074,14 @@ the options are:
Let's display a class from rst2pdf::

.. code-block:: python
:include: ../rst2pdf/flowables.py
:include: includes/flowables.py
:start-at: class Separation(Flowable):
:end-before: class Reference(Flowable):

this command gives

.. code-block:: python
:include: ../rst2pdf/flowables.py
:include: includes/flowables.py
:start-at: class Separation(Flowable):
:end-before: class Reference(Flowable):
Expand Down Expand Up @@ -1381,6 +1381,17 @@ as text, the math role embeds an image. That means:

So, use it only in emergencies ;-)

You can also use an inline substitution of the math directive for things you use often,
which is the same as using the math role::

This is the square of x: |xsq|

.. |xsq| math:: x^2

This is the square of x: |xsq|

.. |xsq| math:: x^2

You don't need to worry about fonts, the correct math fonts will be used and embedded in
your PDF automatically (they are included with matplotlib).

Expand Down Expand Up @@ -1810,30 +1821,30 @@ Several are included with rst2pdf.
Preprocess (``-e preprocess``)
------------------------------

.. include:: ../rst2pdf/extensions/preprocess_r2p.py
.. include:: ../../rst2pdf/extensions/preprocess_r2p.py
:start-after: '''
:end-before: '''

Inkscape (``-e inkscape``)
--------------------------

.. include:: ../rst2pdf/extensions/inkscape_r2p.py
.. include:: ../../rst2pdf/extensions/inkscape_r2p.py
:start-after: '''
:end-before: '''


Dotted_TOC (``-e dotted_toc``)
------------------------------

.. include:: ../rst2pdf/extensions/dotted_toc.py
.. include:: ../../rst2pdf/extensions/dotted_toc.py
:start-after: '''
:end-before: '''


Developers
==========

.. include:: DEVELOPERS.rst
.. include:: ../DEVELOPERS.rst
:start-line: 8


Expand Down
2 changes: 1 addition & 1 deletion doc/manual.style → doc/manual/manual.style
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"frames": [
["0cm", "0cm", "100%", "100%"]
],
"background" : "biohazard.pdf",
"background" : "images/biohazard.pdf",
"showHeader" : false,
"showFooter" : false
}
Expand Down
File renamed without changes.
File renamed without changes.

0 comments on commit e9e497f

Please sign in to comment.