Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [udig-devel] walkthrough 1 updated to sphinx

Great! Are you still working on the transformation from odt to rst?
I have completed walkthrough 1. And updated the content. 
Is the user doc conversion completed that we can start working on the content?
I would like a review of the user doc conversion; we may wish to tweak things a bit before calling it done and working on the content.
 
Today I worked on styling (removed background image) and fixed links in the top navigation div.

I had a look at the origin odt file and the converted rst's a here some comments:
- the images are references with pattern |image_name_extension|. I'm not sure about the current committed rst files but I expected a result like this from the the BulkConvert class :
.. image::image/import_wiz.png
I was going to ask you about that; should I generate the following instead:

.. image:: /image/import_wiz.png 

(This would allow us to group the "tasks pages" into a task folder, since the "/image/import_wizard.png" would refer to the root directory conf.py is defined)

The other more exciting option is to have it generate something like:

.. image:: /../../../plugins/net.refractions.udig.catalog.ui/wizban/import_wiz.png

(This would pull the same image into the docs as is currently sued for the application)

Let me know if you think either of these ideas is worth experimenting and running the conversion again. 
- I tested a bit with sidebars and have a solution for the notes within the odt files (I assume these were not converted by the odt2sphinx tool and we have to check ist after conversion):
You assumption is correct; this was something I did manually after conversion. 
   - I added an additional line in layout.html of the udig theme : {%- block sidebar2 %}{% endblock %}
   - I tested the ..sidebar:: directive in the ImportDirectlytoTheCatalog.rst file
   - we can think about using ..notes:: directives instead but this would create longer pages than with the sidebar.
I am not really worried about page length on a web page - so if "notes" is better just let me know.

Question: For the GeoServer Install workbook I combined everything into a single page - should I do this for walkthrough 1?
- I thought about using the rst2pdf extension to export pdf out of it but it failed to install it with sudo easy_install rst2pdf. I guess its because of my python env (2.5.1) and a missing dependencies .. Do you know how to update python on mac osx (lion)?
Please use "home brew" to install python, and PIL and sphinx-build and so on. It is much easier.
looks good; don't you like how getting CSS to function is so much work; and then so very few lines of code in a diff.

So … how to we push this to udig.github.com? I would like make a blog post once we have anything ready for to show.

Jody

Back to the top