[Geoserver-devel] Problems building GeoServer documentation

Hi all

I am able to successfully build the main branch of GeoServer src with Maven. That is not a problem.

However, I am struggling to build the documentation, both on Windows and Ubuntu. These are the steps I have followed:

cd doc/en
mvn clean install -e -X alternatively mvn compile -Puser -e -X

The problem appears to be with sphinx-build, from the logs:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/peters/geoserver-source/doc/e n/target/docguide/doctrees” . “/home/peters/geoserver-source/doc/en/target/docguide/html”

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: TypeError(‘quote_from_bytes() expected bytes’)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 16.325 s

These are the versions.

python -V
Python 2.7.18
sphinx-build --version
sphinx-build 3.5.2

If the problem is with python2, I have tried to

alias python=python3
python -V
Python 3.8.10
and that also does not help.

Attached is the full output from maven, if that helps.

Can anyone guide me on what the problem might be, please?

Thanks

Peter

(attachments)

mvn.out (353 KB)

Peter,

A number of osgeo projects use this python / sphinx stack for documentation management. For geoserver we use python 3 (which defaults to utc-8) rather than python 2 which has been discontinued.

The instructions (
https://docs.geoserver.org/latest/en/docguide/install.html
) appear a little of out of date. Here are some I have written more recently (https://github.com/GeoCat/geocat-themes/blob/master/README.md).

Jody

···


Jody Garnett

Something has changed recently that broke the build for me too:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/aaime/devel/git-gs/doc/en/target/docguide/doctrees” . “/home/aaime/devel/git-gs/doc/en/target/docguide/html”
[exec] /usr/local/lib/python2.7/dist-packages/sphinx/util/nodes.py:94: FutureWarning:
[exec] The iterable returned by Node.traverse()
[exec] will become an iterator instead of a list in Docutils > 0.16.
[exec] for classifier in reversed(node.parent.traverse(nodes.classifier)):

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: UndefinedError(“‘root_doc’ is undefined”,)

Did not touch the system installation, has built the docs fine till some time ago… Some recent change in the sphinx setup has made the instructions “outdated”.
Tried the instructions from the GeoCat docs, they worked.

Cheers
Andrea

···

Regards,

Andrea Aime

==
GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information.

Ing. Andrea Aime
@geowolf
Technical Lead

GeoSolutions Group
phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia.

This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

Oh I know this one, it often annoys me when doing theme development it usually has to do with parent / child table of contents relationships being messed up somehow. Sometimes if you are just doing incremental builds locally you can introduce a problem of this nature…

Let me check out main and build all the docs.

···


Jody Garnett

Hi Jody,
I just followed the instructions on the GeoCat site and then, it built.
No changes in the docs.

However, it was building just fine until some time ago (weeks?) so some recent change must have broken
a previously working setup, and now requires a more recent sphinx version, it seems.

Cheers
Andrea

···

Regards,

Andrea Aime

==
GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information.

Ing. Andrea Aime
@geowolf
Technical Lead

GeoSolutions Group
phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia.

This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

Andrea,

I keep having this issue. What do you mean exactly with the instructions on the GeoCat site? I cannot resolve it.

Kind Regards

Niels

···

On 13/10/2021 09:42, Andrea Aime wrote:

Hi Jody,
I just followed the instructions on the GeoCat site and then, it built.
No changes in the docs.

However, it was building just fine until some time ago (weeks?) so some recent change must have broken
a previously working setup, and now requires a more recent sphinx version, it seems.

Cheers
Andrea

On Tue, Oct 12, 2021 at 7:20 PM Jody Garnett <jody.garnett@anonymised.com> wrote:

Oh I know this one, it often annoys me when doing theme development it usually has to do with parent / child table of contents relationships being messed up somehow. Sometimes if you are just doing incremental builds locally you can introduce a problem of this nature…

Let me check out main and build all the docs.


Jody Garnett

On Tue, 12 Oct 2021 at 01:42, Andrea Aime <andrea.aime@anonymised.com> wrote:

Something has changed recently that broke the build for me too:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/aaime/devel/git-gs/doc/en/target/docguide/doctrees” . “/home/aaime/devel/git-gs/doc/en/target/docguide/html”
[exec] /usr/local/lib/python2.7/dist-packages/sphinx/util/nodes.py:94: FutureWarning:
[exec] The iterable returned by Node.traverse()
[exec] will become an iterator instead of a list in Docutils > 0.16.
[exec] for classifier in reversed(node.parent.traverse(nodes.classifier)):

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: UndefinedError(“‘root_doc’ is undefined”,)

Did not touch the system installation, has built the docs fine till some time ago… Some recent change in the sphinx setup has made the instructions “outdated”.
Tried the instructions from the GeoCat docs, they worked.

Cheers
Andrea

On Sat, Oct 9, 2021 at 5:48 PM Jody Garnett <jody.garnett@anonymised.com> wrote:

Peter,

A number of osgeo projects use this python / sphinx stack for documentation management. For geoserver we use python 3 (which defaults to utc-8) rather than python 2 which has been discontinued.

The instructions (
https://docs.geoserver.org/latest/en/docguide/install.html
) appear a little of out of date. Here are some I have written more recently (https://github.com/GeoCat/geocat-themes/blob/master/README.md).

Jody

On Wed, Oct 6, 2021 at 11:15 AM Peter Smythe <gs@anonymised.com> wrote:

Hi all

I am able to successfully build the main branch of GeoServer src with Maven. That is not a problem.

However, I am struggling to build the documentation, both on Windows and Ubuntu. These are the steps I have followed:

cd doc/en
mvn clean install -e -X alternatively mvn compile -Puser -e -X

The problem appears to be with sphinx-build, from the logs:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/peters/geoserver-source/doc/e n/target/docguide/doctrees” . “/home/peters/geoserver-source/doc/en/target/docguide/html”

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: TypeError(‘quote_from_bytes() expected bytes’)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 16.325 s

These are the versions.

python -V
Python 2.7.18
sphinx-build --version
sphinx-build 3.5.2

If the problem is with python2, I have tried to

alias python=python3
python -V
Python 3.8.10
and that also does not help.

Attached is the full output from maven, if that helps.

Can anyone guide me on what the problem might be, please?

Thanks

Peter


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


Jody Garnett


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

Regards,

Andrea Aime

== GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information. == Ing. Andrea Aime @geowolf Technical Lead

GeoSolutions Group phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

Regards,

Andrea Aime

== GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information. == Ing. Andrea Aime @geowolf Technical Lead

GeoSolutions Group phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

_______________________________________________
Geoserver-devel mailing list
[Geoserver-devel@lists.sourceforge.net](mailto:Geoserver-devel@lists.sourceforge.net)
[https://lists.sourceforge.net/lists/listinfo/geoserver-devel](https://lists.sourceforge.net/lists/listinfo/geoserver-devel)

I just go to docs/en and do mvn install - do you have sphinx installed?

Ian

···

Ian Turton

Hello Ian,

Yes, I get the same error from sphinx as Andrea did back then.

Kind Regards

Niels

···

On 26/04/2022 12:18, Ian Turton wrote:

I just go to docs/en and do mvn install - do you have sphinx installed?

Ian

On Tue, 26 Apr 2022 at 11:11, Niels Charlier via Geoserver-devel <geoserver-devel@lists.sourceforge.net> wrote:

Andrea,

I keep having this issue. What do you mean exactly with the instructions on the GeoCat site? I cannot resolve it.

Kind Regards

Niels

On 13/10/2021 09:42, Andrea Aime wrote:

Hi Jody,
I just followed the instructions on the GeoCat site and then, it built.
No changes in the docs.

However, it was building just fine until some time ago (weeks?) so some recent change must have broken
a previously working setup, and now requires a more recent sphinx version, it seems.

Cheers
Andrea

On Tue, Oct 12, 2021 at 7:20 PM Jody Garnett <jody.garnett@anonymised.com> wrote:

Oh I know this one, it often annoys me when doing theme development it usually has to do with parent / child table of contents relationships being messed up somehow. Sometimes if you are just doing incremental builds locally you can introduce a problem of this nature…

Let me check out main and build all the docs.


Jody Garnett

On Tue, 12 Oct 2021 at 01:42, Andrea Aime <andrea.aime@anonymised.com> wrote:

Something has changed recently that broke the build for me too:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/aaime/devel/git-gs/doc/en/target/docguide/doctrees” . “/home/aaime/devel/git-gs/doc/en/target/docguide/html”
[exec] /usr/local/lib/python2.7/dist-packages/sphinx/util/nodes.py:94: FutureWarning:
[exec] The iterable returned by Node.traverse()
[exec] will become an iterator instead of a list in Docutils > 0.16.
[exec] for classifier in reversed(node.parent.traverse(nodes.classifier)):

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: UndefinedError(“‘root_doc’ is undefined”,)

Did not touch the system installation, has built the docs fine till some time ago… Some recent change in the sphinx setup has made the instructions “outdated”.
Tried the instructions from the GeoCat docs, they worked.

Cheers
Andrea

On Sat, Oct 9, 2021 at 5:48 PM Jody Garnett <jody.garnett@anonymised.com> wrote:

Peter,

A number of osgeo projects use this python / sphinx stack for documentation management. For geoserver we use python 3 (which defaults to utc-8) rather than python 2 which has been discontinued.

The instructions (
https://docs.geoserver.org/latest/en/docguide/install.html
) appear a little of out of date. Here are some I have written more recently (https://github.com/GeoCat/geocat-themes/blob/master/README.md).

Jody

On Wed, Oct 6, 2021 at 11:15 AM Peter Smythe <gs@anonymised.com> wrote:

Hi all

I am able to successfully build the main branch of GeoServer src with Maven. That is not a problem.

However, I am struggling to build the documentation, both on Windows and Ubuntu. These are the steps I have followed:

cd doc/en
mvn clean install -e -X alternatively mvn compile -Puser -e -X

The problem appears to be with sphinx-build, from the logs:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/peters/geoserver-source/doc/e n/target/docguide/doctrees” . “/home/peters/geoserver-source/doc/en/target/docguide/html”

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: TypeError(‘quote_from_bytes() expected bytes’)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 16.325 s

These are the versions.

python -V
Python 2.7.18
sphinx-build --version
sphinx-build 3.5.2

If the problem is with python2, I have tried to

alias python=python3
python -V
Python 3.8.10
and that also does not help.

Attached is the full output from maven, if that helps.

Can anyone guide me on what the problem might be, please?

Thanks

Peter


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


Jody Garnett


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

Regards,

Andrea Aime

== GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information. == Ing. Andrea Aime @geowolf Technical Lead

GeoSolutions Group phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

Regards,

Andrea Aime

== GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information. == Ing. Andrea Aime @geowolf Technical Lead

GeoSolutions Group phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

_______________________________________________
Geoserver-devel mailing list
[Geoserver-devel@lists.sourceforge.net](mailto:Geoserver-devel@lists.sourceforge.net)
[https://lists.sourceforge.net/lists/listinfo/geoserver-devel](https://lists.sourceforge.net/lists/listinfo/geoserver-devel)


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

Ian Turton

Try a clean first, and review your change for any toctree directive changes. As indicated this is sometimes an issue with parent / child relationships.

Jody

···


Jody Garnett

Hi Jody,

I get the error after cleaning, I also get it without any changes (on an updated and untouched main branch).

Note that the error is:

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: UndefinedError(“‘root_doc’ is undefined”)

Exactly the same as what Andrea had. I was hoping he could clarify how he resolved it? (Not sure where to find the ‘GeoCat docs’ for this issue)

Kind Regards

Niels

···

On 27/04/2022 02:28, Jody Garnett wrote:

Try a clean first, and review your change for any toctree directive changes. As indicated this is sometimes an issue with parent / child relationships.

Jody

On Tue, Apr 26, 2022 at 12:27 AM Niels Charlier via Geoserver-devel <geoserver-devel@lists.sourceforge.net> wrote:

Hello Ian,

Yes, I get the same error from sphinx as Andrea did back then.

Kind Regards

Niels

On 26/04/2022 12:18, Ian Turton wrote:

I just go to docs/en and do mvn install - do you have sphinx installed?

Ian

On Tue, 26 Apr 2022 at 11:11, Niels Charlier via Geoserver-devel <geoserver-devel@lists.sourceforge.net> wrote:

Andrea,

I keep having this issue. What do you mean exactly with the instructions on the GeoCat site? I cannot resolve it.

Kind Regards

Niels

On 13/10/2021 09:42, Andrea Aime wrote:

Hi Jody,
I just followed the instructions on the GeoCat site and then, it built.
No changes in the docs.

However, it was building just fine until some time ago (weeks?) so some recent change must have broken
a previously working setup, and now requires a more recent sphinx version, it seems.

Cheers
Andrea

On Tue, Oct 12, 2021 at 7:20 PM Jody Garnett <jody.garnett@anonymised.com> wrote:

Oh I know this one, it often annoys me when doing theme development it usually has to do with parent / child table of contents relationships being messed up somehow. Sometimes if you are just doing incremental builds locally you can introduce a problem of this nature…

Let me check out main and build all the docs.


Jody Garnett

On Tue, 12 Oct 2021 at 01:42, Andrea Aime <andrea.aime@anonymised.com> wrote:

Something has changed recently that broke the build for me too:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/aaime/devel/git-gs/doc/en/target/docguide/doctrees” . “/home/aaime/devel/git-gs/doc/en/target/docguide/html”
[exec] /usr/local/lib/python2.7/dist-packages/sphinx/util/nodes.py:94: FutureWarning:
[exec] The iterable returned by Node.traverse()
[exec] will become an iterator instead of a list in Docutils > 0.16.
[exec] for classifier in reversed(node.parent.traverse(nodes.classifier)):

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: UndefinedError(“‘root_doc’ is undefined”,)

Did not touch the system installation, has built the docs fine till some time ago… Some recent change in the sphinx setup has made the instructions “outdated”.
Tried the instructions from the GeoCat docs, they worked.

Cheers
Andrea

On Sat, Oct 9, 2021 at 5:48 PM Jody Garnett <jody.garnett@anonymised.com> wrote:

Peter,

A number of osgeo projects use this python / sphinx stack for documentation management. For geoserver we use python 3 (which defaults to utc-8) rather than python 2 which has been discontinued.

The instructions (
https://docs.geoserver.org/latest/en/docguide/install.html
) appear a little of out of date. Here are some I have written more recently (https://github.com/GeoCat/geocat-themes/blob/master/README.md).

Jody

On Wed, Oct 6, 2021 at 11:15 AM Peter Smythe <gs@anonymised.com> wrote:

Hi all

I am able to successfully build the main branch of GeoServer src with Maven. That is not a problem.

However, I am struggling to build the documentation, both on Windows and Ubuntu. These are the steps I have followed:

cd doc/en
mvn clean install -e -X alternatively mvn compile -Puser -e -X

The problem appears to be with sphinx-build, from the logs:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/peters/geoserver-source/doc/e n/target/docguide/doctrees” . “/home/peters/geoserver-source/doc/en/target/docguide/html”

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: TypeError(‘quote_from_bytes() expected bytes’)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 16.325 s

These are the versions.

python -V
Python 2.7.18
sphinx-build --version
sphinx-build 3.5.2

If the problem is with python2, I have tried to

alias python=python3
python -V
Python 3.8.10
and that also does not help.

Attached is the full output from maven, if that helps.

Can anyone guide me on what the problem might be, please?

Thanks

Peter


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


Jody Garnett


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

Regards,

Andrea Aime

== GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information. == Ing. Andrea Aime @geowolf Technical Lead

GeoSolutions Group phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

Regards,

Andrea Aime

== GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information. == Ing. Andrea Aime @geowolf Technical Lead

GeoSolutions Group phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

_______________________________________________
Geoserver-devel mailing list
[Geoserver-devel@lists.sourceforge.net](mailto:Geoserver-devel@lists.sourceforge.net)
[https://lists.sourceforge.net/lists/listinfo/geoserver-devel](https://lists.sourceforge.net/lists/listinfo/geoserver-devel)


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

Ian Turton


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


Jody Garnett

Hi Niels,
they were linked from Jody’s first message in this thread. Here it is:
https://github.com/GeoCat/geocat-themes/blob/master/README.md

Cheers
Andrea

On Wed, Apr 27, 2022 at 7:42 AM Niels Charlier <niels@anonymised.com> wrote:

Hi Jody,

I get the error after cleaning, I also get it without any changes (on an updated and untouched main branch).

Note that the error is:

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: UndefinedError(“‘root_doc’ is undefined”)

Exactly the same as what Andrea had. I was hoping he could clarify how he resolved it? (Not sure where to find the ‘GeoCat docs’ for this issue)

Kind Regards

Niels

On 27/04/2022 02:28, Jody Garnett wrote:

Try a clean first, and review your change for any toctree directive changes. As indicated this is sometimes an issue with parent / child relationships.

Jody

On Tue, Apr 26, 2022 at 12:27 AM Niels Charlier via Geoserver-devel <geoserver-devel@lists.sourceforge.net> wrote:

Hello Ian,

Yes, I get the same error from sphinx as Andrea did back then.

Kind Regards

Niels

On 26/04/2022 12:18, Ian Turton wrote:

I just go to docs/en and do mvn install - do you have sphinx installed?

Ian

On Tue, 26 Apr 2022 at 11:11, Niels Charlier via Geoserver-devel <geoserver-devel@lists.sourceforge.net> wrote:

Andrea,

I keep having this issue. What do you mean exactly with the instructions on the GeoCat site? I cannot resolve it.

Kind Regards

Niels

On 13/10/2021 09:42, Andrea Aime wrote:

Hi Jody,
I just followed the instructions on the GeoCat site and then, it built.
No changes in the docs.

However, it was building just fine until some time ago (weeks?) so some recent change must have broken
a previously working setup, and now requires a more recent sphinx version, it seems.

Cheers
Andrea

On Tue, Oct 12, 2021 at 7:20 PM Jody Garnett <jody.garnett@anonymised.com> wrote:

Oh I know this one, it often annoys me when doing theme development it usually has to do with parent / child table of contents relationships being messed up somehow. Sometimes if you are just doing incremental builds locally you can introduce a problem of this nature…

Let me check out main and build all the docs.


Jody Garnett

On Tue, 12 Oct 2021 at 01:42, Andrea Aime <andrea.aime@anonymised.com…> wrote:

Something has changed recently that broke the build for me too:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/aaime/devel/git-gs/doc/en/target/docguide/doctrees” . “/home/aaime/devel/git-gs/doc/en/target/docguide/html”
[exec] /usr/local/lib/python2.7/dist-packages/sphinx/util/nodes.py:94: FutureWarning:
[exec] The iterable returned by Node.traverse()
[exec] will become an iterator instead of a list in Docutils > 0.16.
[exec] for classifier in reversed(node.parent.traverse(nodes.classifier)):

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: UndefinedError(“‘root_doc’ is undefined”,)

Did not touch the system installation, has built the docs fine till some time ago… Some recent change in the sphinx setup has made the instructions “outdated”.
Tried the instructions from the GeoCat docs, they worked.

Cheers
Andrea

On Sat, Oct 9, 2021 at 5:48 PM Jody Garnett <jody.garnett@anonymised.com> wrote:

Peter,

A number of osgeo projects use this python / sphinx stack for documentation management. For geoserver we use python 3 (which defaults to utc-8) rather than python 2 which has been discontinued.

The instructions (
https://docs.geoserver.org/latest/en/docguide/install.html
) appear a little of out of date. Here are some I have written more recently (https://github.com/GeoCat/geocat-themes/blob/master/README.md).

Jody

On Wed, Oct 6, 2021 at 11:15 AM Peter Smythe <gs@anonymised.com> wrote:

Hi all

I am able to successfully build the main branch of GeoServer src with Maven. That is not a problem.

However, I am struggling to build the documentation, both on Windows and Ubuntu. These are the steps I have followed:

cd doc/en
mvn clean install -e -X alternatively mvn compile -Puser -e -X

The problem appears to be with sphinx-build, from the logs:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/peters/geoserver-source/doc/e n/target/docguide/doctrees” . “/home/peters/geoserver-source/doc/en/target/docguide/html”

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: TypeError(‘quote_from_bytes() expected bytes’)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 16.325 s

These are the versions.

python -V
Python 2.7.18
sphinx-build --version
sphinx-build 3.5.2

If the problem is with python2, I have tried to

alias python=python3
python -V
Python 3.8.10
and that also does not help.

Attached is the full output from maven, if that helps.

Can anyone guide me on what the problem might be, please?

Thanks

Peter


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


Jody Garnett


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

Regards,

Andrea Aime

== GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information. == Ing. Andrea Aime @geowolf Technical Lead

GeoSolutions Group phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

Regards,

Andrea Aime

== GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information. == Ing. Andrea Aime @geowolf Technical Lead

GeoSolutions Group phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

_______________________________________________
Geoserver-devel mailing list
[Geoserver-devel@lists.sourceforge.net](mailto:Geoserver-devel@lists.sourceforge.net)
[https://lists.sourceforge.net/lists/listinfo/geoserver-devel](https://lists.sourceforge.net/lists/listinfo/geoserver-devel)


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

Ian Turton


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


Jody Garnett

Ah! Thanks. The pip instructions for windows (although I use linux) fixed the problem. Sphinx outdated or missing modules?

Kind Regards

Niels

···

On 27/04/2022 11:27, Andrea Aime wrote:

Hi Niels,
they were linked from Jody’s first message in this thread. Here it is:
https://github.com/GeoCat/geocat-themes/blob/master/README.md

Cheers
Andrea

On Wed, Apr 27, 2022 at 7:42 AM Niels Charlier <niels@anonymised.com> wrote:

Hi Jody,

I get the error after cleaning, I also get it without any changes (on an updated and untouched main branch).

Note that the error is:

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: UndefinedError(“‘root_doc’ is undefined”)

Exactly the same as what Andrea had. I was hoping he could clarify how he resolved it? (Not sure where to find the ‘GeoCat docs’ for this issue)

Kind Regards

Niels

On 27/04/2022 02:28, Jody Garnett wrote:

Try a clean first, and review your change for any toctree directive changes. As indicated this is sometimes an issue with parent / child relationships.

Jody

On Tue, Apr 26, 2022 at 12:27 AM Niels Charlier via Geoserver-devel <geoserver-devel@lists.sourceforge.net> wrote:

Hello Ian,

Yes, I get the same error from sphinx as Andrea did back then.

Kind Regards

Niels

On 26/04/2022 12:18, Ian Turton wrote:

I just go to docs/en and do mvn install - do you have sphinx installed?

Ian

On Tue, 26 Apr 2022 at 11:11, Niels Charlier via Geoserver-devel <geoserver-devel@lists.sourceforge.net> wrote:

Andrea,

I keep having this issue. What do you mean exactly with the instructions on the GeoCat site? I cannot resolve it.

Kind Regards

Niels

On 13/10/2021 09:42, Andrea Aime wrote:

Hi Jody,
I just followed the instructions on the GeoCat site and then, it built.
No changes in the docs.

However, it was building just fine until some time ago (weeks?) so some recent change must have broken
a previously working setup, and now requires a more recent sphinx version, it seems.

Cheers
Andrea

On Tue, Oct 12, 2021 at 7:20 PM Jody Garnett <jody.garnett@anonymised.com> wrote:

Oh I know this one, it often annoys me when doing theme development it usually has to do with parent / child table of contents relationships being messed up somehow. Sometimes if you are just doing incremental builds locally you can introduce a problem of this nature…

Let me check out main and build all the docs.


Jody Garnett

On Tue, 12 Oct 2021 at 01:42, Andrea Aime <andrea.aime@anonymised.com> wrote:

Something has changed recently that broke the build for me too:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/aaime/devel/git-gs/doc/en/target/docguide/doctrees” . “/home/aaime/devel/git-gs/doc/en/target/docguide/html”
[exec] /usr/local/lib/python2.7/dist-packages/sphinx/util/nodes.py:94: FutureWarning:
[exec] The iterable returned by Node.traverse()
[exec] will become an iterator instead of a list in Docutils > 0.16.
[exec] for classifier in reversed(node.parent.traverse(nodes.classifier)):

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: UndefinedError(“‘root_doc’ is undefined”,)

Did not touch the system installation, has built the docs fine till some time ago… Some recent change in the sphinx setup has made the instructions “outdated”.
Tried the instructions from the GeoCat docs, they worked.

Cheers
Andrea

On Sat, Oct 9, 2021 at 5:48 PM Jody Garnett <jody.garnett@anonymised.com> wrote:

Peter,

A number of osgeo projects use this python / sphinx stack for documentation management. For geoserver we use python 3 (which defaults to utc-8) rather than python 2 which has been discontinued.

The instructions (
https://docs.geoserver.org/latest/en/docguide/install.html
) appear a little of out of date. Here are some I have written more recently (https://github.com/GeoCat/geocat-themes/blob/master/README.md).

Jody

On Wed, Oct 6, 2021 at 11:15 AM Peter Smythe <gs@anonymised.com> wrote:

Hi all

I am able to successfully build the main branch of GeoServer src with Maven. That is not a problem.

However, I am struggling to build the documentation, both on Windows and Ubuntu. These are the steps I have followed:

cd doc/en
mvn clean install -e -X alternatively mvn compile -Puser -e -X

The problem appears to be with sphinx-build, from the logs:

sphinx:
[echo] Running sphinx-build -D release=2.21-SNAPSHOT -W -b html -d “/home/peters/geoserver-source/doc/e n/target/docguide/doctrees” . “/home/peters/geoserver-source/doc/en/target/docguide/html”

[exec] Theme error:
[exec] An error happened in rendering the page background.
[exec] Reason: TypeError(‘quote_from_bytes() expected bytes’)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 16.325 s

These are the versions.

python -V
Python 2.7.18
sphinx-build --version
sphinx-build 3.5.2

If the problem is with python2, I have tried to

alias python=python3
python -V
Python 3.8.10
and that also does not help.

Attached is the full output from maven, if that helps.

Can anyone guide me on what the problem might be, please?

Thanks

Peter


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


Jody Garnett


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

Regards,

Andrea Aime

== GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information. == Ing. Andrea Aime @geowolf Technical Lead

GeoSolutions Group phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

Regards,

Andrea Aime

== GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information. == Ing. Andrea Aime @geowolf Technical Lead

GeoSolutions Group phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 333 8128928

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it


Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

_______________________________________________
Geoserver-devel mailing list
[Geoserver-devel@lists.sourceforge.net](mailto:Geoserver-devel@lists.sourceforge.net)
[https://lists.sourceforge.net/lists/listinfo/geoserver-devel](https://lists.sourceforge.net/lists/listinfo/geoserver-devel)


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

Ian Turton


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


Jody Garnett