[geomoose-psc] GeoMoose Doc building

[Brent Fraser]

I was just thinking of  including a little bit of doc for the new/casual user on how it contribute to the doc:  

Contributing to GeoMoose Documentation
-------------------------------------------------------
Our doc uses reStructureText format....
Clone the repo by ....
To create HTML from .rst install Sphinx...., run make or our make.bat...
Submit a pull request contain your doc contribution....

or something like that.

Brent

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

From: Jim Klassen <klassen.js at gmail.com>
Sent: 3/22/21 9:50 AM
To: geomoose-psc at lists.osgeo.org
Subject: Re: [geomoose-psc] GeoMoose Doc building

This is what I use to build the docs on the server:

$SPHINX_VENV/bin/sphinx-build -En $SOURCE_DIR/gm3/docs $HTML_DOCS_DIR/3.x

There are many ways someone could install sphinx that would work: 

https://www.sphinx-doc.org/en/master/usage/installation.html

On the server, I've got it sphinx installed in a virtualenv with pip (pip install sphinx).   The version of sphinx in the distributions (apt-get/yum/dnf/...) tend to be too far out of date so installing from pip/conda/etc. is preferred.  I know that Sphinx 1.6.7 which is packaged with Ubuntu 18.04 is too old.

The server is currently running Sphinx 3.4.2, but newer should work.  Older will probably work to a point.   I don't remember how far back that point is at the moment.

On 3/22/21 9:55 AM, Brent Fraser wrote:

Hi All,

So I thought I would start integrating my Vector Editing doc into the code base at geomoose/gm3/docs.  But there doesn't seem to be any info/scripts in the repo for building our doc.  Should there be?

Thanks!
Brent

_______________________________________________
geomoose-psc mailing list
geomoose-psc at lists.osgeo.org
https://lists.osgeo.org/mailman/listinfo/geomoose-psc
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/geomoose-psc/attachments/20210322/31b21b35/attachment.html>