I ran into some trouble using sphinx-action to include class documentations. The documentation part is inside the class/function definitions inside the package code.
Local build by using sphinx make html
But when i build the documentation by the provided package, the result is the following:
So i added the -e . option in the requirements.txt file for this github action.
The the package to install requires minimum python 3.10.
By using setup-python, the version is pinned to 3.10.
The first run pip install -e . works perfect using python 3.10.
When coming to the Build HTML section, with the -e . option, the following error appears.
ERROR: Package 'femmt' requires a different Python: 3.8.2 not in '>=3.10'
It seems like, for this package is python 3.8 used. It is not clear for me, why?
When i remove the -e . option inside the requirements.txt, the documentation is bild without the class description as shown as in the second figure.
Do you have any ideas how to use python 3.10 for the build process?
Or are there any other ways to overcome this drawback?
I ran into some trouble using sphinx-action to include class documentations. The documentation part is inside the class/function definitions inside the package code.
Local build by using sphinx
make html
But when i build the documentation by the provided package, the result is the following:
According to this answer, i want to include the package as given. https://stackoverflow.com/questions/73033594/github-action-using-wrong-version-of-python
So i added the
-e .
option in the requirements.txt file for this github action.The the package to install requires minimum python 3.10.
By using
setup-python
, the version is pinned to3.10
. The first runpip install -e .
works perfect using python 3.10.When coming to the
Build HTML
section, with the-e .
option, the following error appears.It seems like, for this package is python
3.8
used. It is not clear for me, why? When i remove the-e .
option inside therequirements.txt
, the documentation is bild without the class description as shown as in the second figure.Do you have any ideas how to use python 3.10 for the build process? Or are there any other ways to overcome this drawback?
here is the build file: