[Geoserver-devel] sphinx who are you?

Ciao,
quick question, I have been looking around trying to install sphinx on
my windows laptop so that I can write docs wherever I am , expecially
in spare time. However I haven't found a decent guide yet that would
guide through the process. Does anyone have a link to a tutorial or
something like it?

Simone.
-------------------------------------------------------
Ing. Simone Giannecchini
GeoSolutions S.A.S.
Owner - Software Engineer
Via Carignoni 51
55041 Camaiore (LU)
Italy

phone: +39 0584983027
fax: +39 0584983027
mob: +39 333 8128928

http://www.geo-solutions.it
http://simboss.blogspot.com/
http://www.linkedin.com/in/simonegiannecchini

-------------------------------------------------------

Simone Giannecchini ha scritto:

Ciao,
quick question, I have been looking around trying to install sphinx on
my windows laptop so that I can write docs wherever I am , expecially
in spare time. However I haven't found a decent guide yet that would
guide through the process. Does anyone have a link to a tutorial or
something like it?

I could not find one but somehow I managed to install it when I still
was working on Windows. The vague steps I remember:
- installed Python itself (ActiveState version I believe, not sure)
- installed MSYS (http://www.mingw.org/wiki/msys)
- don't remember if I installed easy-install or if that came along
   with the Python install (it's part of the setup-tools packages
   on Linux, don't remember for Windows)
- put all of the above in the classpath

Then you run:
easy-install sphinx

and this installs sphinx,

cd doc/user
make html

And this generates the documentation.

In order to generate PDF one has to install Latex along with all
the imaginable extras because our setup is using a font that is
not in the base Latex installs (at least not on Linux).

Cheers
Andrea

--
Andrea Aime
OpenGeo - http://opengeo.org
Expert service straight from the developers.

Grazie Andrea,
just for the records, I am adding some more info down below...
-------------------------------------------------------
Ing. Simone Giannecchini
GeoSolutions S.A.S.
Owner - Software Engineer
Via Carignoni 51
55041 Camaiore (LU)
Italy

phone: +39 0584983027
fax: +39 0584983027
mob: +39 333 8128928

http://www.geo-solutions.it
http://simboss.blogspot.com/
http://www.linkedin.com/in/simonegiannecchini

-------------------------------------------------------

On Fri, Jun 12, 2009 at 9:29 AM, Andrea Aime<aaime@anonymised.com> wrote:

Simone Giannecchini ha scritto:

Ciao,
quick question, I have been looking around trying to install sphinx on
my windows laptop so that I can write docs wherever I am , expecially
in spare time. However I haven't found a decent guide yet that would
guide through the process. Does anyone have a link to a tutorial or
something like it?

I could not find one but somehow I managed to install it when I still
was working on Windows. The vague steps I remember:
- installed Python itself (ActiveState version I believe, not sure)
- installed MSYS (http://www.mingw.org/wiki/msys)

I already had that installed, so that windows looks like ubuntu, just
a little bit more unstable :-).

- don't remember if I installed easy-install or if that came along
with the Python install (it's part of the setup-tools packages
on Linux, don't remember for Windows)
- put all of the above in the classpath

I have installed python 2.5.4 from here
http://www.python.org/download/releases/2.5.4/ (you need to add it to
the path)
and setup_tools from here http://pypi.python.org/pypi/setuptools (you
need to add to the path the dir %PYTHON_PATH%\Scripts)

Then you run:
easy-install sphinx

and this installs sphinx,

cd doc/user
make html

worked as a charm

And this generates the documentation.

In order to generate PDF one has to install Latex along with all
the imaginable extras because our setup is using a font that is
not in the base Latex installs (at least not on Linux).

Good to see that someone is still using latex. I have been forced to
abandone it since everybody wanted .doc or.odt, I think it's about
time to revamp my latex skills.

Simone.

Cheers
Andrea

--
Andrea Aime
OpenGeo - http://opengeo.org
Expert service straight from the developers.

------------------------------------------------------------------------------
Crystal Reports - New Free Runtime and 30 Day Trial
Check out the new simplified licensing option that enables unlimited
royalty-free distribution of the report engine for externally facing
server and web deployment.
http://p.sf.net/sfu/businessobjects
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel

Simone Giannecchini ha scritto:

Grazie Andrea,
just for the records, I am adding some more info down below...

Following this up I created
http://jira.codehaus.org/browse/GEOS-3151

and already committed in the docguide tips on how to install
Shinx on Windows and Ubuntu. I managed to test the windows
steps, but I did not have a clean Ubuntu machine to test
the Ubuntu ones, so if anyone can, please check.

Also, I did not include the steps to install Latex and
the necessary extensions. If someone wants to figure out
that part, would be nice.

Finally, I can't provide steps for a Mac install, but they
would be nice too I guess

Cheers
Andrea

--
Andrea Aime
OpenGeo - http://opengeo.org
Expert service straight from the developers.

For the record, MSYS isn't required (I don't use it), but it means that instead of using:

   make html

you build manually:

   sphinx-build -b html /sourcedir /targetdir

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

Andrea Aime wrote:

Simone Giannecchini ha scritto:

Ciao,
quick question, I have been looking around trying to install sphinx on
my windows laptop so that I can write docs wherever I am , expecially
in spare time. However I haven't found a decent guide yet that would
guide through the process. Does anyone have a link to a tutorial or
something like it?

I could not find one but somehow I managed to install it when I still
was working on Windows. The vague steps I remember:
- installed Python itself (ActiveState version I believe, not sure)
- installed MSYS (http://www.mingw.org/wiki/msys)
- don't remember if I installed easy-install or if that came along
   with the Python install (it's part of the setup-tools packages
   on Linux, don't remember for Windows)
- put all of the above in the classpath

Then you run:
easy-install sphinx

and this installs sphinx,

cd doc/user
make html

And this generates the documentation.

In order to generate PDF one has to install Latex along with all
the imaginable extras because our setup is using a font that is
not in the base Latex installs (at least not on Linux).

Cheers
Andrea

Mike Pumphrey ha scritto:

For the record, MSYS isn't required (I don't use it), but it means that instead of using:

  make html

you build manually:

  sphinx-build -b html /sourcedir /targetdir

You sure like to type a lot :wink:

Cheers
Andrea

--
Andrea Aime
OpenGeo - http://opengeo.org
Expert service straight from the developers.

Has anyone investigated having sphinx run in jython? Could be really nice if we could run it without making people figure out how to install python, etc.

On Fri, Jun 12, 2009 at 2:35 AM, Simone Giannecchini <simone.giannecchini@anonymised.com> wrote:

Ciao,
quick question, I have been looking around trying to install sphinx on
my windows laptop so that I can write docs wherever I am , expecially
in spare time. However I haven’t found a decent guide yet that would
guide through the process. Does anyone have a link to a tutorial or
something like it?

Simone.

Ing. Simone Giannecchini
GeoSolutions S.A.S.
Owner - Software Engineer
Via Carignoni 51
55041 Camaiore (LU)
Italy

phone: +39 0584983027
fax: +39 0584983027
mob: +39 333 8128928

http://www.geo-solutions.it
http://simboss.blogspot.com/
http://www.linkedin.com/in/simonegiannecchini



Crystal Reports - New Free Runtime and 30 Day Trial
Check out the new simplified licensing option that enables unlimited
royalty-free distribution of the report engine for externally facing
server and web deployment.
http://p.sf.net/sfu/businessobjects


Geoserver-devel mailing list
Geoserver-devel@anonymised.comsts.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel

Chris Holmes ha scritto:

Has anyone investigated having sphinx run in jython? Could be really nice if we could run it without making people figure out how to install python, etc.

I had a really quick look around on the internet, found nothing.
Asked on the #jython channel, got nothing
Tried anyways and got an error about pkg_resource not being available,
which in turns needs the installation of setup tools under jython,
which I don't know how to do. I guess we'd need a python developer
to look into this, and the thing should not end up requiring much
more steps than the current native python setup to be interesting
(I mean, it has to be simpler to be valuable no?)

Cheers
Andrea

--
Andrea Aime
OpenGeo - http://opengeo.org
Expert service straight from the developers.