In response to some questions on the users list about missing files from
the Sphinx documentation, I took a look into ensuring that auxiliary
files linked from the documentation get included in the HTML output.
As of Sphinx 0.6, this is as simple as using the :download: role to link
to the file:
:download:`nyc_roads.shp`
The broken links were using external links instead:
`<nyc_roads.shp>`_
If you're using a previous version of Sphinx, you'll need to upgrade to
avoid broken links in the output.
As an aside, I found linkchecker (http://linkchecker.sourceforge.net/)
quite useful in making sure the links were good.
-d
Sweet!! Nice find David.
It might be nice to add a note to the docguide about that, we probably need to add some "nice to knows" section or something. Currently it is just all about writing style and conventions.
-Justin
David Winslow wrote:
In response to some questions on the users list about missing files from
the Sphinx documentation, I took a look into ensuring that auxiliary
files linked from the documentation get included in the HTML output.
As of Sphinx 0.6, this is as simple as using the :download: role to link
to the file:
:download:`nyc_roads.shp`
The broken links were using external links instead: `<nyc_roads.shp>`_
If you're using a previous version of Sphinx, you'll need to upgrade to
avoid broken links in the output.
As an aside, I found linkchecker (http://linkchecker.sourceforge.net/)
quite useful in making sure the links were good.
-d
------------------------------------------------------------------------------
Register Now for Creativity and Technology (CaT), June 3rd, NYC. CaT
is a gathering of tech-side developers & brand creativity professionals. Meet
the minds behind Google Creative Lab, Visual Complexity, Processing, & iPhoneDevCamp asthey present alongside digital heavyweights like Barbarian
Group, R/GA, & Big Spaceship. http://www.creativitycat.com _______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel
--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.
Info is added to the Sphinx syntax page in the docguide.
Thanks again, David, for finding that.
Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org
Justin Deoliveira wrote:
Sweet!! Nice find David.
It might be nice to add a note to the docguide about that, we probably need to add some "nice to knows" section or something. Currently it is just all about writing style and conventions.
-Justin
David Winslow wrote:
In response to some questions on the users list about missing files from
the Sphinx documentation, I took a look into ensuring that auxiliary
files linked from the documentation get included in the HTML output.
As of Sphinx 0.6, this is as simple as using the :download: role to link
to the file:
:download:`nyc_roads.shp`
The broken links were using external links instead: `<nyc_roads.shp>`_
If you're using a previous version of Sphinx, you'll need to upgrade to
avoid broken links in the output.
As an aside, I found linkchecker (http://linkchecker.sourceforge.net/)
quite useful in making sure the links were good.
-d
------------------------------------------------------------------------------
Register Now for Creativity and Technology (CaT), June 3rd, NYC. CaT
is a gathering of tech-side developers & brand creativity professionals. Meet
the minds behind Google Creative Lab, Visual Complexity, Processing, & iPhoneDevCamp asthey present alongside digital heavyweights like Barbarian
Group, R/GA, & Big Spaceship. http://www.creativitycat.com _______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel