[Geoserver-devel] Sphinx dependencies?

Ben_Caradoc-Davies · June 5, 2009, 6:02am

I get a Python exception trying to build the Geoserver 1.7.x user docs with "make html" on Fedora 10 x86_64.

File "/usr/lib64/python2.5/site-packages/jinja/environment.py", line 284, in apply_filters
raise FilterNotFound(filtername)
FilterNotFound: 'safe'

Fedora 10 has python-sphinx-0.5-1.fc10.noarch, which appears to use jinja 1.2 (python-jinja-1.2-1.fc9.x86_64). I also installed python-jinja-2, but this did not fix the problem.

What version of sphinx do I need to build Geoserver 1.7.x docs?

Kind regards,

--
Ben Caradoc-Davies <Ben.Caradoc-Davies@anonymised.com>
Software Engineer, CSIRO Exploration and Mining
Australian Resources Research Centre
26 Dick Perry Ave, Kensington WA 6151, Australia

Andrea_Aime3 · June 5, 2009, 6:08am

Ben Caradoc-Davies ha scritto:

I get a Python exception trying to build the Geoserver 1.7.x user docs with "make html" on Fedora 10 x86_64.

File "/usr/lib64/python2.5/site-packages/jinja/environment.py", line 284, in apply_filters
raise FilterNotFound(filtername)
FilterNotFound: 'safe'

Fedora 10 has python-sphinx-0.5-1.fc10.noarch, which appears to use jinja 1.2 (python-jinja-1.2-1.fc9.x86_64). I also installed python-jinja-2, but this did not fix the problem.

What version of sphinx do I need to build Geoserver 1.7.x docs?

Latest and greatest (0.6.1 I believe), installed using easy_install
(provided in python-setuptools in ubuntu).
At least, that's what I'm using and how I installed it. Mike or
David should know more

Cheers
Andrea

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

Ben_Caradoc-Davies · June 5, 2009, 6:55am

Andrea Aime wrote:

Ben Caradoc-Davies ha scritto:

What version of sphinx do I need to build Geoserver 1.7.x docs?

Latest and greatest (0.6.1 I believe), installed using easy_install
(provided in python-setuptools in ubuntu).
At least, that's what I'm using and how I installed it. Mike or
David should know more

Thanks, Andrea, I built sphinx 0.6.1 from source and I can now build the GeoServer 1.7.x docs as html.

Did you see my other email? Would you like me to commit the app-schema tutorial to the 1.7.x branch docs, or wait for 1.7.x docs to be copied to trunk?

Kind regards,

--
Ben Caradoc-Davies <Ben.Caradoc-Davies@anonymised.com>
Software Engineer, CSIRO Exploration and Mining
Australian Resources Research Centre
26 Dick Perry Ave, Kensington WA 6151, Australia

Andrea_Aime3 · June 5, 2009, 7:03am

Ben Caradoc-Davies ha scritto:

Did you see my other email? Would you like me to commit the app-schema tutorial to the 1.7.x branch docs, or wait for 1.7.x docs to be copied to trunk?

I haven't been much involved in the documentation so far so I don't know... but I guess it would make no harm if you commit a tutorial
there so that people can have a look and it is moved on trunk
when things are properly setup.

Just make sure the tutorial does not show up in the official docs
(e.g, don't link it from the index pages) we don't want people to
download the 1.7.x docs and think we support complext features there already.

A direct link to the tutorial for other devs to look at should
be more than enough

Cheers
Andrea

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

Ben_Caradoc-Davies · June 5, 2009, 7:45am

Andrea Aime wrote:

Just make sure the tutorial does not show up in the official docs
(e.g, don't link it from the index pages) we don't want people to
download the 1.7.x docs and think we support complext features there already.

That is my plan. I see it complains about unlinked rest docs, so I expect it to generate html even for pages that are not linked from an index.

A direct link to the tutorial for other devs to look at should
be more than enough

A link to source, or will the html be published?

--
Ben Caradoc-Davies <Ben.Caradoc-Davies@anonymised.com>
Software Engineer, CSIRO Exploration and Mining
Australian Resources Research Centre
26 Dick Perry Ave, Kensington WA 6151, Australia

Andrea_Aime3 · June 5, 2009, 7:55am

Ben Caradoc-Davies ha scritto:

Andrea Aime wrote:

Just make sure the tutorial does not show up in the official docs
(e.g, don't link it from the index pages) we don't want people to
download the 1.7.x docs and think we support complext features there already.

That is my plan. I see it complains about unlinked rest docs, so I expect it to generate html even for pages that are not linked from an index.

A direct link to the tutorial for other devs to look at should
be more than enough

A link to source, or will the html be published?

I believe it will be published, but again I'm not so involved
in the docs stuff. I see there is a hudson build for it:
http://gridlock.openplans.org:8080/hudson/job/geoserver-1.7.x-docs/
which I believe feeds this version of the docs:
http://gridlock.openplans.org/geoserver/1.7.x/doc/

But I may be wrong, I'm mostly looking around and guessing
Cheers
Andrea

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

Michael_Melvin · June 5, 2009, 2:36pm

Hi Ben. I'm just getting back into doc work after a bit of an absence, and I'm looking forward to your app-schema docs as I know very little about it. I know that Justin has copied the skeleton of the 1.7.x docs to trunk.

https://svn.codehaus.org/geoserver/trunk/doc/user/source/

As you can see, there's nothing there (yet). That said, if your app-schema tutorial applies to 2.0 and not 1.7.x, I think it would make sense to post your tutorial to trunk.

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

Ben Caradoc-Davies wrote:

Andrea Aime wrote:

Ben Caradoc-Davies ha scritto:

What version of sphinx do I need to build Geoserver 1.7.x docs?

Latest and greatest (0.6.1 I believe), installed using easy_install
(provided in python-setuptools in ubuntu).
At least, that's what I'm using and how I installed it. Mike or
David should know more

Thanks, Andrea, I built sphinx 0.6.1 from source and I can now build the GeoServer 1.7.x docs as html.

Did you see my other email? Would you like me to commit the app-schema tutorial to the 1.7.x branch docs, or wait for 1.7.x docs to be copied to trunk?

Kind regards,

Michael_Melvin · June 5, 2009, 2:59pm

That is my plan. I see it complains about unlinked rest docs, so I expect it to generate html even for pages that are not linked from an index.

I consider errors/warnings in the sphinx build to be bugs. Please open JIRAs when you find them.

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

Ben Caradoc-Davies wrote:

Andrea Aime wrote:

Just make sure the tutorial does not show up in the official docs
(e.g, don't link it from the index pages) we don't want people to
download the 1.7.x docs and think we support complext features there already.

That is my plan. I see it complains about unlinked rest docs, so I expect it to generate html even for pages that are not linked from an index.

A direct link to the tutorial for other devs to look at should
be more than enough

A link to source, or will the html be published?

Andrea_Aime3 · June 5, 2009, 4:02pm

Mike Pumphrey ha scritto:

Hi Ben. I'm just getting back into doc work after a bit of an
absence, and I'm looking forward to your app-schema docs as I know
very little about it. I know that Justin has copied the skeleton of
the 1.7.x docs to trunk.

https://svn.codehaus.org/geoserver/trunk/doc/user/source/

As you can see, there's nothing there (yet). That said, if your
app-schema tutorial applies to 2.0 and not 1.7.x, I think it would
make sense to post your tutorial to trunk.

I agree it would be better. However, Ben told us trunk docs do not
build... given the option of having him figure out why or
let him temporarily commit on 1.7.x, I suggested to go the
second way, so that we can all have a look at the docs
while the situation on trunk is resolved.

It would be great if anyone knowledgeable about Sphinx could
fix whatever the problems are on trunk.

This morning I did not try out, as I'm not knowledgeable about
the build setup of sphinx. Oh well, tried just now to make a build in
doc/user and the output is:

Running Sphinx v0.6.1
loading pickled environment... not found
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index

writing additional files... search
copying static files... WARNING: static directory '/home/aaime/devel/gstrunk/doc/user/source/../../theme/_static' does not exist
done
dumping search index... done
dumping object inventory... done
build succeeded, 1 warning.

So maybe the issue is just with the theming?
The best solution would be to solve the problem enough
to have Ben commit directly on trunk without having him
stuck waiting for action from us.

Then again, the above build seems good enough to commit
the docs, at worse they will look bad? Not sure....

Cheers
Andrea

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

Michael_Melvin · June 5, 2009, 6:23pm

Yes, looks like the theme wasn't carried over to trunk. I added it (r12565) and now I don't get any building errors on trunk. There's still no content there, but I'll take a look at porting the skeleton structure now.

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

Andrea Aime wrote:

Mike Pumphrey ha scritto:

Hi Ben. I'm just getting back into doc work after a bit of an
absence, and I'm looking forward to your app-schema docs as I know
very little about it. I know that Justin has copied the skeleton of
the 1.7.x docs to trunk.

https://svn.codehaus.org/geoserver/trunk/doc/user/source/

As you can see, there's nothing there (yet). That said, if your
app-schema tutorial applies to 2.0 and not 1.7.x, I think it would
make sense to post your tutorial to trunk.

I agree it would be better. However, Ben told us trunk docs do not
build... given the option of having him figure out why or
let him temporarily commit on 1.7.x, I suggested to go the
second way, so that we can all have a look at the docs
while the situation on trunk is resolved.

It would be great if anyone knowledgeable about Sphinx could
fix whatever the problems are on trunk.

This morning I did not try out, as I'm not knowledgeable about
the build setup of sphinx. Oh well, tried just now to make a build in
doc/user and the output is:

Running Sphinx v0.6.1
loading pickled environment... not found
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
writing additional files... search
copying static files... WARNING: static directory '/home/aaime/devel/gstrunk/doc/user/source/../../theme/_static' does not exist
done
dumping search index... done
dumping object inventory... done
build succeeded, 1 warning.

So maybe the issue is just with the theming?
The best solution would be to solve the problem enough
to have Ben commit directly on trunk without having him
stuck waiting for action from us.

Then again, the above build seems good enough to commit
the docs, at worse they will look bad? Not sure....

Cheers
Andrea

Ben_Caradoc-Davies · June 8, 2009, 1:41am

Thanks very much, Mike. I can confirm that the user docs build on trunk. I'll put the app-schema tutorial there.

Kind regards,
Ben.

Mike Pumphrey wrote:

Yes, looks like the theme wasn't carried over to trunk. I added it (r12565) and now I don't get any building errors on trunk. There's still no content there, but I'll take a look at porting the skeleton structure now.

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

Andrea Aime wrote:

Mike Pumphrey ha scritto:

Hi Ben. I'm just getting back into doc work after a bit of an
absence, and I'm looking forward to your app-schema docs as I know
very little about it. I know that Justin has copied the skeleton of
the 1.7.x docs to trunk.

https://svn.codehaus.org/geoserver/trunk/doc/user/source/

As you can see, there's nothing there (yet). That said, if your
app-schema tutorial applies to 2.0 and not 1.7.x, I think it would
make sense to post your tutorial to trunk.

I agree it would be better. However, Ben told us trunk docs do not
build... given the option of having him figure out why or
let him temporarily commit on 1.7.x, I suggested to go the
second way, so that we can all have a look at the docs
while the situation on trunk is resolved.

It would be great if anyone knowledgeable about Sphinx could
fix whatever the problems are on trunk.

This morning I did not try out, as I'm not knowledgeable about
the build setup of sphinx. Oh well, tried just now to make a build in
doc/user and the output is:

Running Sphinx v0.6.1
loading pickled environment... not found
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
writing additional files... search
copying static files... WARNING: static directory '/home/aaime/devel/gstrunk/doc/user/source/../../theme/_static' does not exist
done
dumping search index... done
dumping object inventory... done
build succeeded, 1 warning.

So maybe the issue is just with the theming?
The best solution would be to solve the problem enough
to have Ben commit directly on trunk without having him
stuck waiting for action from us.

Then again, the above build seems good enough to commit
the docs, at worse they will look bad? Not sure....

Cheers
Andrea

--
Ben Caradoc-Davies <Ben.Caradoc-Davies@anonymised.com>
Software Engineer, CSIRO Exploration and Mining
Australian Resources Research Centre
26 Dick Perry Ave, Kensington WA 6151, Australia