Documenting with Python-Sphinx

18 views
Skip to first unread message

Alan Bromborsky

unread,
May 20, 2014, 6:59:31 PM5/20/14
to sympy
At the end of my documentation "ga.rst" I have

Manifolds and Tensors
^^^^^^^^^^^^^^^^^^^^^

An example

.. literalinclude:: latex/maxwell.py
:language: python

code output

.. image:: latex/manifold-0.png
:width: 700px
:align: left

.. image:: latex/manifold-1.png
:width: 800px
:align: left

.. rubric:: Citations

.. [Doran] `<http://www.mrao.cam.ac.uk/~cjld1/pages/book.htm>`_
``Geometric Algebra for Physicists`` by C. Doran and A. Lasenby,
Cambridge
University Press, 2003.

.. [Hestenes] `<http://geocalc.clas.asu.edu/html/CA_to_GC.html>`_
``Clifford Algebra to Geometric Calculus`` by D.Hestenes and G.
Sobczyk, Kluwer
Academic Publishers, 1984.

.. [Macdonald] '<http://faculty.luther.edu/~macdonal>'_
``Linear and Geometric Algebra`` by Alan Macdonald,
`<http://www.amazon.com/Alan-Macdonald/e/B004MB2QJQ>`_


.. rubric:: Footnotes

.. [#f0] In this case :math:`D_{B}^{j_{1}\dots j_{n}} = F` and
:math:`\partial_{j_{1}\dots j_{n}} = 1`.

.. [#f1] Since :math:`\underline{T}` is linear we do not require
:math:`I^{2} = \pm 1`.

.. [#f2] In this case :math:`y` is a vector in the tangent space and not
a coordinate vector so that the
basis vectors are {\em not} a function of :math:`y`.

.. [#f3] Preprocessing do not occur for the Ipython notebook and the
string post processing commands
*\%* and *\#* are not used in this case


When I display the html in Firefox the last two images,
"manifold-0.png" and "manifold-0.png", are side by side with
with ".. rubric:: Citations" and ".. rubric:: Footnotes". Am I doing
the citations and footnotes correctly? How can I display
the citations and footnotes after the images?






Aaron Meurer

unread,
May 20, 2014, 8:19:28 PM5/20/14
to sy...@googlegroups.com
Maybe it's the align: left?

Aaron Meurer
> --
> You received this message because you are subscribed to the Google Groups
> "sympy" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sympy+un...@googlegroups.com.
> To post to this group, send email to sy...@googlegroups.com.
> Visit this group at http://groups.google.com/group/sympy.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/sympy/537BDE53.70507%40verizon.net.
> For more options, visit https://groups.google.com/d/optout.

Alan Bromborsky

unread,
May 20, 2014, 11:08:32 PM5/20/14
to sy...@googlegroups.com
Thank you. That did it. There are none so blind as those who will not see!
Reply all
Reply to author
Forward
0 new messages