Hi,
just stumbled into this https://readthedocs.org/ site, which appears to be a free hosting site for docs made with sphinx.
It has integration with Github, can build docs from tags and the like (versioning is supported), has a search engine, and builds PDF versions (ePub too) of the docs.
Sounds kinda nice, I also see GeoNode has some docs over there:
https://readthedocs.org/projects/geonode/
Anyone already tried it?
I’m tempted to setup an account to see how it works out.
Cheers
Andrea
–
==
GeoServer training in Milan, 6th & 7th June 2013! Visit http://geoserver.geo-solutions.it for more information.
Ing. Andrea Aime
@geowolf
Technical Lead
GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
fax: +39 0584 1660272
mob: +39 339 8844549
http://www.geo-solutions.it
http://twitter.com/geosolutions_it
Hi Andrea
Sounds promising.
Your mail reminds me to pose a question. Did you test the eclipse sphinx plugin ?. I am using it and there are some nice features like
-
syntax highlighting
-
spell check (English)
-
import the documentation as a project
-
run configuration for the make file
-
the documentation is participating in the global eclipse file search (useful for code snippets as an example if you are renaming/deleting/modifying classes).
Christian
···
2013/5/5 Andrea Aime <andrea.aime@anonymised.com>
Hi,
just stumbled into this https://readthedocs.org/ site, which appears to be a free hosting site for docs made with sphinx.
It has integration with Github, can build docs from tags and the like (versioning is supported), has a search engine, and builds PDF versions (ePub too) of the docs.
Sounds kinda nice, I also see GeoNode has some docs over there:
https://readthedocs.org/projects/geonode/
Anyone already tried it?
I’m tempted to setup an account to see how it works out.
Cheers
Andrea
–
==
GeoServer training in Milan, 6th & 7th June 2013! Visit http://geoserver.geo-solutions.it for more information.
Ing. Andrea Aime
@geowolf
Technical Lead
GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
fax: +39 0584 1660272
mob: +39 339 8844549
http://www.geo-solutions.it
http://twitter.com/geosolutions_it
Get 100% visibility into Java/.NET code with AppDynamics Lite
It’s a free troubleshooting tool designed for production
Get down to code-level detail for bottlenecks, with <2% overhead.
Download for free and get started troubleshooting in minutes.
http://p.sf.net/sfu/appdyn_d2d_ap2
Geoserver-devel mailing list
Geoserver-devel@anonymised.comsts.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel
–
DI Christian Mueller MSc (GIS), MSc (IT-Security)
OSS Open Source Solutions GmbH
On Mon, May 6, 2013 at 3:32 PM, Christian Mueller <
christian.mueller@anonymised.com> wrote:
Hi Andrea
Sounds promising.
Your mail reminds me to pose a question. Did you test the eclipse sphinx
plugin ?. I am using it and there are some nice features like
- syntax highlighting
- spell check (English)
- import the documentation as a project
- run configuration for the make file
- the documentation is participating in the global eclipse file search
(useful for code snippets as an example if you are
renaming/deleting/modifying classes).
I did, and sort of liked it, but last time I tried it, it was screwing up
big time the pre-existing formatting
of the rst file.
Is it still behaving like that?
Cheers
Andrea
--
GeoServer training in Milan, 6th & 7th June 2013! Visit
http://geoserver.geo-solutions.it for more information.
Ing. Andrea Aime
@geowolf
Technical Lead
GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
fax: +39 0584 1660272
mob: +39 339 8844549
http://www.geo-solutions.it
http://twitter.com/geosolutions_it
-------------------------------------------------------
I don’t think that ReadtheDocs will allow us to preserve the current theming of the docs (probably not a blocker, but there would no longer be a link to the blog from the manual.) It does let you use a custom domain like http://docs.geonode.org/ . For PDF output I believe they are using the rst2pdf Sphinx extension rather than the default Latex output. Since this uses a Python PDF creation API I think it’s much simpler to set up than Latex. We could set up the GeoServer docs to use rst2pdf without needing to switch over to RTD.
http://rst2pdf.ralsina.com.ar/handbook.html
···
On Mon, May 6, 2013 at 9:44 AM, Andrea Aime <andrea.aime@anonymised.com> wrote:
On Mon, May 6, 2013 at 3:32 PM, Christian Mueller <christian.mueller@anonymised.com3674…> wrote:
Introducing AppDynamics Lite, a free troubleshooting tool for Java/.NET
Get 100% visibility into your production application - at no cost.
Code-level diagnostics for performance bottlenecks with <2% overhead
Download for free and get started troubleshooting in minutes.
http://p.sf.net/sfu/appdyn_d2d_ap1
Geoserver-devel mailing list
Geoserver-devel@anonymised.comsts.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel
Hi Andrea
Sounds promising.
Your mail reminds me to pose a question. Did you test the eclipse sphinx plugin ?. I am using it and there are some nice features like
-
syntax highlighting
-
spell check (English)
-
import the documentation as a project
-
run configuration for the make file
-
the documentation is participating in the global eclipse file search (useful for code snippets as an example if you are renaming/deleting/modifying classes).
I did, and sort of liked it, but last time I tried it, it was screwing up big time the pre-existing formatting
of the rst file.
Is it still behaving like that?
Cheers
Andrea
–
==
GeoServer training in Milan, 6th & 7th June 2013! Visit http://geoserver.geo-solutions.it for more information.
Ing. Andrea Aime
@geowolf
Technical Lead
GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
fax: +39 0584 1660272
mob: +39 339 8844549
http://www.geo-solutions.it
http://twitter.com/geosolutions_it
On Mon, May 6, 2013 at 3:57 PM, David Winslow <dwinslow@anonymised.com> wrote:
I don't think that ReadtheDocs will allow us to preserve the current
theming of the docs (probably not a blocker, but there would no longer be a
link to the blog from the manual.) It does let you use a custom domain
like http://docs.geonode.org/ . For PDF output I believe they are using
the rst2pdf Sphinx extension rather than the default Latex output. Since
this uses a Python PDF creation API I think it's much simpler to set up
than Latex. We could set up the GeoServer docs to use rst2pdf without
needing to switch over to RTD.
http://rst2pdf.ralsina.com.ar/handbook.html
Yes, I've read something about rst2pdf, but also spotted a thread on the
rst2pdf where Roberto Alsina
said he no longer uses, and thus no longer supports, Sphinx as a rst
source... but I cannot find it
anymore.
That happened like one week ago while I was trying to use it, found an
error, and the error brought
me to that ml thread...
Has anyone else succeeded in using rst2pdf?
Cheers
Andrea
--
GeoServer training in Milan, 6th & 7th June 2013! Visit
http://geoserver.geo-solutions.it for more information.
Ing. Andrea Aime
@geowolf
Technical Lead
GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
fax: +39 0584 1660272
mob: +39 339 8844549
http://www.geo-solutions.it
http://twitter.com/geosolutions_it
-------------------------------------------------------
On Mon, May 6, 2013 at 4:40 PM, Andrea Aime <andrea.aime@anonymised.com>wrote:
Yes, I've read something about rst2pdf, but also spotted a thread on the
rst2pdf where Roberto Alsina
said he no longer uses, and thus no longer supports, Sphinx as a rst
source... but I cannot find it
anymore.
Of course I find it 30 seconds after sending the mail:
https://groups.google.com/forum/?fromgroups=#!searchin/rst2pdf-discuss/sphinx/rst2pdf-discuss/C2J-n2dq_zw/D4Kz5bX6wDIJ
Cheers
Andrea
--
GeoServer training in Milan, 6th & 7th June 2013! Visit
http://geoserver.geo-solutions.it for more information.
Ing. Andrea Aime
@geowolf
Technical Lead
GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
fax: +39 0584 1660272
mob: +39 339 8844549
http://www.geo-solutions.it
http://twitter.com/geosolutions_it
-------------------------------------------------------