Add documentation about pylatex HOT 12 CLOSED

Adding the PDF files generated by the examples should help.

from pylatex.

In addition to the generated PDF files, a markdown file containing all present functions and their parameters, type and return values can be made. However, I don't have an idea of how big would it become this way.

from pylatex.

I'm planning on learning how to set up sphinx documentation this summer. That way the docstrings in the code will be converted to documentation automatically.

from pylatex.

Okay. So I added stuff for the "Library Usage" section, but are there any other big things that you need help working on documentation-wise?

from pylatex.

All that's left is basically adding semi useful docstrings for everything. And moving the contributing instructions to the actual documentation, and add stuff about how the documentation works to it.

If you want to write docstrings, use the numpy format since those are actually useful. See this for explanation. http://sphinx-doc.org/latest/ext/napoleon.html

And you can make html in the docs directory to generate the actual documentation.

from pylatex.

I'll write the contributing stuff myself btw

from pylatex.

Question: Why do Arguments and Options exist if they're just Parameters with an extra boolean flag put on?

from pylatex.

Good question. I wanted to change that. Forgot about that.
On 21 Aug 2015 2:32 am, "Roger Filmyer" [email protected] wrote:

Question: Why do Arguments and Options exist if they're just Parameters
with an extra boolean flag put on?

—
Reply to this email directly or view it on GitHub
#7 (comment).

from pylatex.

I guess there are a few situations where having Options and Parameters could be of use. E.g. last month, I needed my options/arguments to be in a certain order.
I'm not saying that can't be done with more primitive parameters, but I'd rather take a look on all possible usages of arguments and options in the latex ecosystem and then make the decision.
Cheers
On Aug 21, 2015 9:19 AM, Jelte Fennema [email protected] wrote:Good question. I wanted to change that. Forgot about that.
On 21 Aug 2015 2:32 am, "Roger Filmyer" [email protected] wrote:

Question: Why do Arguments and Options exist if they're just Parameters
with an extra boolean flag put on?

—
Reply to this email directly or view it on GitHub
#7 (comment).

—Reply to this email directly or view it on GitHub.

from pylatex.

I do want to keep Options and Arguments, but the logic that handles them should be changed. The differences are currently handled in the Parameters class and I want to move that to the actual Options and Arguments classes.

from pylatex.

I have just pushed a change that removes the optional boolean and handles it in a different and cleaner way.

from pylatex.

I am going to close this issue and make a couple of new issues that split this up.

from pylatex.