Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sphinx version 2.4 needed to build the docs #398

Closed
winksaville opened this issue Jul 10, 2020 · 1 comment
Closed

Sphinx version 2.4 needed to build the docs #398

winksaville opened this issue Jul 10, 2020 · 1 comment

Comments

@winksaville
Copy link
Contributor

With conda 4.8.3 on my Arch Linux system the default sphinx version is 3.1:

$ conda -V
conda 4.8.3
$ sphinx-build --version
sphinx-build 3.1.1

And I get the following error when running ./build-docs.sh:

$ ./build-docs.sh 
Running Sphinx v3.1.1

Exception occurred:
  File "/opt/anaconda/envs/cqgui-master3/lib/python3.7/site-packages/cadquery/cq_directive.py", line 93, in setup
    app.add_directive("cq_plot", cq_directive, True, (0, 2, 0), **options)
TypeError: add_directive() got an unexpected keyword argument 'height'
The full traceback has been saved in /tmp/sphinx-err-euymmkgl.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

Adam suggested switching to 2.4 and that does builds the doc successfully, although there are WARNINGS:

$ ./build-docs.sh 
Running Sphinx v2.4.4
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/sphinx/util/docutils.py:287: RemovedInSphinx30Warning: function based directive support is now deprecated. Use class based directive instead.
  RemovedInSphinx30Warning)
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 14 source files that are out of date
updating environment: [new config] 14 added, 0 changed, 0 removed
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/utils.py:21: FutureWarning: Default walue of centerOption will change in the next relase to ProjectedOrigin                                                              
  FutureWarning,
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/utils.py:34: FutureWarning: combineSolids will be removed in the next relase.
  warn(f"{f.__name__} will be removed in the next relase.", FutureWarning)
Traceback (most recent call last):g                                                                                                                                                                                                            
  File "/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq_directive.py", line 53, in cq_directive
    raise result.exception
  File "/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cqgi.py", line 117, in build
    exec(c, env)
  File "<cqscript>", line 20, in <module>
  File "<cqscript>", line 12, in makeCubes
  File "/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py", line 2221, in eachpoint
    res = [callback(p).move(loc) for p in pnts]
  File "/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py", line 2221, in <listcomp>
    res = [callback(p).move(loc) for p in pnts]
  File "<cqscript>", line 8, in _singleCube
NameError: name 'pnt' is not defined
reading sources... [100%] selectors                                                                                                                                                                                                            
WARNING: failed to import Workplane.rotateAndCopy
WARNING: failed to import BoxSelector
WARNING: failed to import BaseDirSelector
WARNING: failed to import DirectionNthSelector
WARNING: failed to import BinarySelector
WARNING: failed to import AndSelector
WARNING: failed to import SumSelector
WARNING: failed to import SubtractSelector
WARNING: failed to import InverseSelector
WARNING: failed to import BoxSelector
WARNING: failed to import BaseDirSelector
WARNING: failed to import DirectionNthSelector
WARNING: failed to import BinarySelector
WARNING: failed to import AndSelector
WARNING: failed to import SumSelector
WARNING: failed to import SubtractSelector
WARNING: failed to import InverseSelector
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py:docstring of cadquery.Workplane.ellipse:10: WARNING: Unexpected indentation.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py:docstring of cadquery.Workplane.ellipse:11: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py:docstring of cadquery.Workplane.ellipse:16: WARNING: Unexpected indentation.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py:docstring of cadquery.Workplane.interpPlate:11: WARNING: Unexpected indentation.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py:docstring of cadquery.Workplane.interpPlate:12: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py:docstring of cadquery.Workplane.interpPlate:14: WARNING: Field list ends without a blank line; unexpected unindent.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py:docstring of cadquery.Workplane.wedge:5: WARNING: Field list ends without a blank line; unexpected unindent.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py:docstring of cadquery.Workplane.wedge:11: WARNING: Unexpected indentation.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/cq.py:docstring of cadquery.Workplane.wedge:12: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/occ_impl/shapes.py:docstring of cadquery.Wire.assembleEdges:6: WARNING: Unexpected indentation.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/selectors.py:docstring of cadquery.StringSyntaxSelector:36: WARNING: Inline substitution_reference start-string without end-string.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/selectors.py:docstring of cadquery.StringSyntaxSelector:36: WARNING: Inline substitution_reference start-string without end-string.
/opt/anaconda/envs/cqgui-master4/lib/python3.7/site-packages/cadquery/selectors.py:docstring of cadquery.StringSyntaxSelector:40: WARNING: Inline substitution_reference start-string without end-string.
/home/wink/prgs/CadQuery/forks/cadquery/doc/installation.rst:11: WARNING: Title underline too short.

Anaconda or Miniconda (Python 3.x editions), Python 3.x
----------------------------------------------
/home/wink/prgs/CadQuery/forks/cadquery/doc/intro.rst:57: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/home/wink/prgs/CadQuery/forks/cadquery/doc/intro.rst:58: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/wink/prgs/CadQuery/forks/cadquery/doc/quickstart.rst:7: WARNING: duplicate object description of cadquery, other instance in classreference, use :noindex: for one of them
/home/wink/prgs/CadQuery/forks/cadquery/doc/quickstart.rst:12: WARNING: Title underline too short.

Prerequisites: Anaconda/Miniconda + CQ-editor running from an environment
==============================================================
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] selectors                                                                                                                                                                                                             
generating indices...  genindex py-modindexdone
highlighting module code... [100%] cadquery.selectors                                                                                                                                                                                          
writing additional pages...  searchdone
copying images... [100%] _static/quickstart/005.png                                                                                                                                                                                            
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 35 warnings.

The HTML pages are in target/docs.

Possible solution is to add sphinx 2.4 as a run dependency

winksaville added a commit to winksaville/cadquery that referenced this issue Jul 10, 2020
With conda 4.8.3 on my Arch Linux system the default sphinx version is
3.1. I get the following error when running `./build-docs.sh`:

$ ./build-docs.sh
Running Sphinx v3.1.1

 Exception occurred:
   File "/opt/anaconda/envs/cqgui-master3/lib/python3.7/site-packages/cadquery/cq_directive.py", line 93, in setup
     app.add_directive("cq_plot", cq_directive, True, (0, 2, 0), **options)
 TypeError: add_directive() got an unexpected keyword argument 'height'
 The full traceback has been saved in /tmp/sphinx-err-euymmkgl.log, if you want to report the issue to the developers.
 Please also report this if it was a user error, so that a better error message can be provided next time.
 A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

With sphinx 2.4 I was able to build the docs.

Fixes CadQuery#398
@adam-urbanczyk
Copy link
Member

Sphinx is not a runtime dependency of CQ. The development environment (also used by readthedocs build server) is specified here: https://github.com/CadQuery/cadquery/blob/master/environment.yml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants