doc: add variables

[dacoex]

Hello,

anything against adding
https://github.com/pvlib/pvlib-python/wiki/Variables-and-style-rules
to the sphinx docs?

this way, I have them with me also when offline.

[wholmgren]

Sure, that makes sense now that the names have stabilized. Can you make a pr?

[dacoex]

sure.

I suggest to use
http://docutils.sourceforge.net/docs/ref/rst/directives.html#csv-table

Do you agree?

[wholmgren]

Why do you prefer this to the standard sphinx table format? I think the sphinx format is easier to read in the doc source code.

[dacoex]

Was fastest to implement.
Additionally, the csv values can be reused, e.g. to assign variables or translate variables into descriptions.

[wholmgren]

Ok, well I am confused about the status since you closed your PR and deleted your branch. Please provide a link to rtd's rendering your branch when you (re)open your PR.

[dacoex]

I am definitly not a git pro. But I tried to pack my 3 commits together. So maybe github closed it through the commands.
The link is here:
#103
Thanks.

[dacoex]

Shall we also compare the parameter names with IEC 61724?

[wholmgren]

You'll have to be more specific for me to understand what you're really proposing.

[dacoex]

See:
e6dea98#diff-01c51400deeacb229d692d6a21e7af79R17

[wholmgren]

I'm ok with adding a symbol column, but I don't think we should tie it to the IEC document. I would default to the PVPMC symbols.

[dacoex]

I would default to the PVPMC symbols.

sure, the other one is just for reference.

But it's good in the case one performs performance evaluation with usually bases on the IEC or the contractual formulas.

an units are helpful, too.

[wholmgren]

My preference is for a simple table that is focused on the pvlib-python standards. A handful of links to documents such as the IEC's and PVPMC website could be useful below the table.

[dacoex]

mmh.

[wholmgren]

I don't know what that means.

[dacoex]

Let's start with your proposal.
Ideally, I'd love to have variables, units and refernce to standard side-by-side.

[dacoex]

Comment #102 (comment) implemented in
#103

2 items I find strange:

• RTD stylesheet / template does not support bulleted lists, see the test list below.
• RTD stylesheet / template does not support line wrapping in CSV table directive.

I tested these 2 1 items with a fresh sphinx project and there it worked:
https://github.com/dacoex/pvlib_doc_testing/tree/master/build/html
https://raw.githubusercontent.com/dacoex/pvlib_doc_testing/master/build/html/variables_style_rules.html

Looking forward to your feedback to be able to close this issue ;-)

[dacoex]

Clsong since the PR #103 was merged.