Call for docs!

[Diogo Baeder]

Hi guys!

We're on Read The Docs! Here's the link:

https://provy.readthedocs.org/en/latest/

Yeah, I know, the documentation is not ready yet, there's plenty of stuff to do. Mostly:

• Port the current website layout to sphinx theme, and apply it to our docs;
• Port the current API docstrings to sphinx+rst syntax, so that we get rid of that weird new API docs that were generated by sphinx;
• Some minor fixes here and there (mostly pointing to new links or to correct internal sphinx documents).

These tasks - specially the middle one - will take a huge amount of time to be done, so I'd like to ask for some help from you guys. Any help porting them would be much appreciated! :-)

Here are some syntax help pages, for whom may want to give me a hand on this:

http://sphinx-doc.org/rest.html

http://sphinx-doc.org/markup/index.html

http://sphinx-doc.org/domains.html

Also, we have enabled a post-commit hook for doc generation in RTD, so every push will trigger a re-generation of the docs (as well as a CI build).

We won't remove the current website (at GitHub pages) for now, as we still need it as a reference, but as soon as we have this new documentation finished, I'd like to disable the current one.

Cheers!

__________________________
Diogo Baeder
http://diogobaeder.com.br

[Diogo Baeder]

Oh, some more things:

• To generate the docs in your machine, for testing purposes, go to <provy-root>/docs and enter "make html";
• There's an interesting rst editor for Ubuntu called "ReText": "sudo apt-get install retext"
• If you get some code to work on, please open an issue in our GitHub project telling which module you're working at. This will avoid conflicts with your buddies. :-)

Cheers!

__________________________
Diogo Baeder
http://diogobaeder.com.br

[Diogo Baeder]

I'm doing the transcription of the docs for provy.core, right now. An example of docstring that I think is nice to have is this:

https://provy.readthedocs.org/en/latest/api/provy.core.html#provy.core.roles.Role.execute

Cheers!

__________________________
Diogo Baeder
http://diogobaeder.com.br

[Diogo Baeder]

Core is done: https://provy.readthedocs.org/en/latest/api/provy.core.html

You might want to grab some hints, there, if you want; Or drop suggestions, here, if you think it can be improved. :-)

I'll move to provy.more.debian.security, now.

Cheers!

__________________________
Diogo Baeder
http://diogobaeder.com.br

[Fernando]

On 24 January 2013 21:18, Diogo Baeder <diogo...@gmail.com> wrote:

Core is done: https://provy.readthedocs.org/en/latest/api/provy.core.html

You might want to grab some hints, there, if you want; Or drop suggestions, here, if you think it can be improved. :-)

Looks great, congrats!
 

--
http://about.me/fernandogrd

[Diogo Baeder]

Thanks, Fernando! :-)

Hey, could you take, perhaps, provy.more.centos.database? This would be very helpful, if you have some time for it.

Cheers,

__________________________
Diogo Baeder
http://diogobaeder.com.br

[Diogo Baeder]

Alright, API docs for provy.more.debian are done. Moving on to provy.more.centos now.

If anyone has merge clashes, because of these docstring changes, please let me know, and I'll help you sort it out.

Cheers!

__________________________
Diogo Baeder
http://diogobaeder.com.br

[Diogo Baeder]

provy.more.centos done, API docs done!

I'll focus on two things now:

• Finish migrating the "recipes" section;
• Migrating the layout, to bring back the visual identity - and, hopefully, bring back the smile to Heynemann's face as well :-P

After this, I believe we can start some serious refactoring. There's a lot of duplicated code, which I intend to get rid of with https://github.com/python-provy/provy/issues/83 , together with https://github.com/python-provy/provy/issues/79 .

Cheers!

__________________________
Diogo Baeder
http://diogobaeder.com.br

[Diogo Baeder]

Recipes done, old layout migrated to new docs: https://provy.readthedocs.org/en/latest/index.html

Please let me know what you think about the layout - Bernardo, is this close to what you wanted? If not, can you give me some advice to improve it?

Cheers!

__________________________
Diogo Baeder
http://diogobaeder.com.br

[Bernardo Heynemann]

I will. I'm in Argentina now, though

--
You received this message because you are subscribed to the Google Groups "provy" group.
To unsubscribe from this group and stop receiving emails from it, send an email to provy+un...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

[Diogo Baeder]

No problem, take your time :-)

__________________________
Diogo Baeder
http://diogobaeder.com.br

[Fernando]

I like it =)

--
You received this message because you are subscribed to the Google Groups "provy" group.
To unsubscribe from this group and stop receiving emails from it, send an email to provy+un...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

--
http://about.me/fernandogrd