[Bf-docboard] Update on Wiki to RestructuredText conversion

[Campbell Barton]

Did anyone try get the docs and build them? so far this has been me
and Francesco, but if the project is to be a success, we will need
others to become involved.
For the migration and for ongoing improvements.

We realize the barrier of entry is high (using git for technical
writers), and may eventually have a way to avoid writings having to
use git or sphinx (directly) at all. (We're keeping an eye on possible
solutions).

But for now its important that we can see if the system is usable.
That the team who writes docs even is able to use it effectively, or
finds it better then the wiki.



On Fri, Aug 29, 2014 at 8:31 PM, Francesco Siddi
<francesco.siddi at gmail.com> wrote:
> Hello everyone,
> an important update on the documentation migration:
>
> - we created a project on https://developer.blender.org/project/view/53/
> - the new sphinx-based documentation is available here
> https://developer.blender.org/diffusion/BM/
>
> The project is now open for contribution, so we welcome any volunteer
> willing to check out the documentation and do content edits and structure
> refactoring for basically any section. General instructions on how to do
> this are available in the project description. At the moment, in order to
> contribute, there are a few requirements:
>
> - basic knowledge of GIT (checkout, commit, diff)
> - basic knowledge of Sphinx and reST (the documentation system)
> - an account on developer.blender.org (so you can write comments in the
> project tasks or raise issues there)
>
> About translations and versioning:
>
> - currently we are trying to set up this documentation in English (many
> sections are unmaintained and some are outdated back to 2.4x)
> - if this migration succeeds, we will support other languages in parallel
> repos
> - currently we are working for the 2.7x series, and the idea is to use
> git-tags for greater versions
> - older documentation will stay on wiki.blender.org until this documentation
> fully functional
>
> We are happy to hear feedback and comments! Also, we are working on trying
> to make this infrastructure simpler, to easily allow casual contribution.
>
> Reminder: this project is about the User Manual. Everything else (developers
> docs, proposals, release logs, module owners list, etc) will stay on the
> wiki.
>
> Thanks,
> Francesco
>
>
> On 3 Jul 2014 at 10:35:13, Campbell Barton (ideasman42 at gmail.com) wrote:
>
> On Thu, Jul 3, 2014 at 5:47 PM, marco ardito <ardito at apiform.to.it> wrote:
>> Hi, campbell,
>>
>> nice clean look! but... a TOC should be, well, a TOC, not a full index! :)
>> look at the TOC page source. Something like that, with links... :) but
>> that will be tuned later, I'm sure.
>
> Yep, this needs cleaning up, basic structure is there but need to
> change how top-level categories show.
>
> Attempting to do this automatic isnt that valuable IMHO, once we do
> final conversion re-arranging TOC isn't so hard.
>
>> about the look, it's clean but it needs some tweaking. Great job, anyway
>> for an automatic conversion!
>>
>> I'm doing a wiki > pdf conversion since a while, updated each month. atm
>> I stopped to see how the sphinx-doc trial went on, hoping that soon the
>> old pdf could be no more needed!! great! converting the wiki in pdf is
>> fun but also a pain :)
>
> With sphinx we can provide the HTML as a downloadable archive, IMHO
> this is more usable then the PDF,
> I generated a PDF for our sphinx python reference for a while but it
> wasnt that great, I removed and dont think anyone noticed.
>
>> Do you have any pdf conversion test?
>
> I did do one, but cant recall if I uploaded- It does an OK job, but
> image layout sometimes doesn't look right.
>
> Heres sphinx generated PDF, though there aren't any images.
> http://www.blender.org/documentation/blender_python_api_2_59_0/blender_python_reference_2_59_0.pdf
>
> To summarize we can have PDF book if we want, but I always found the
> output inferior to the HTML docs.
>
>> Thanks, Marco
>>
>> Il 02/07/2014 23:29, Campbell Barton ha scritto:
>>> Hi, quick update on the progress migrating the wiki,
>>
>>
>>
>>
>> -------------------
>> [Ai sensi e per gli effetti della Legge sulla tutela della privacy
>> (L. 196/2003), questa mail è destinata unicamente alle persone sopra
>> indicate e le informazioni in essa contenute sono da considerarsi
>> strettamente riservate. E' proibito leggere, copiare, usare o
>> diffondere il contenuto della presente mail senza autorizzazione.
>> Se avete ricevuto questo messaggio per errore, siete pregati di
>> rispedire la stessa al mittente. Grazie]
>>
>> _______________________________________________
>> Bf-docboard mailing list
>> Bf-docboard at blender.org
>> http://lists.blender.org/mailman/listinfo/bf-docboard
>
>
>
> --
> - Campbell
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> http://lists.blender.org/mailman/listinfo/bf-docboard
>
>
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> http://lists.blender.org/mailman/listinfo/bf-docboard
>



-- 
- Campbell