Giter VIP home page Giter VIP logo

Comments (3)

photoniker avatar photoniker commented on August 26, 2024

My latest docu build was successful with Sphinx 7.2. 7.3 is quite new... Did you try some other Sphinx Major Version 7?

from itom.

photoniker avatar photoniker commented on August 26, 2024

This issue was fix by Sphinx in version 7.3.6 Changelog.

I build the docu successfully
image

@hefl99 Please try the version 7.3.6 and close this issue, if the build was successfull.

from itom.

hefl99 avatar hefl99 commented on August 26, 2024

That escalated quickly,

issue filed and closed at breathe within 24hrs. ^^
Sphinx has fixed the bug an backloged their releases up to version: v.7.3.0

In our documentation, I found a small error. "requirementsDocuBuild.txt" was named incorrectly.
Fixed it in corresponding branch an put up a pull-request.

Implemneted yesterday a workaround. I'll publish this code here, just in case

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

In the |itom| sources folder **itom/docs/userDoc**, you can find a
**requirementsDocuBuild.txt** file containing all further necessary python packages
and Sphinx extensions. Install them by using **pip**:

.. code-block: bat

    python.exe -m pip install -r requirementsDocuBuild.txt

Or Install it manually:

* `matplotlib <https://pypi.org/project/matplotlib/>`_
* `numpy <https://pypi.org/project/numpy/>`_
* `openpyxl <https://pypi.org/project/openpyxl/>`_
* `pandas <https://pypi.org/project/pandas/>`_
* `plotly <https://pypi.org/project/plotly/>`_
* `tables <https://pypi.org/project/tables/>`_
* `scikit learn <https://pypi.org/project/scikit-learn/>`_
* `scipy <https://pypi.org/project/scipy/>`_
* `seaborn <https://pypi.org/project/seaborn/>`_

Regarding Python3.12:

Running pip install breathe automatically installs sphinx v7.3.5.
However sphinx v5.3.0 is needed to allow compatibility with breathe.
Issue is reported: https://github.com/itom-project/itom/issues/281. 
Therefore run the following commands in the exact order:

* pip install sphinx==5.3.0
* pip install numpydoc==1.6.0
* pip install breathe==4.35.0
* pip install sphinxcontrib-moderncmakedomain

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

from itom.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.