Skip to content

Commit 2917269

Browse files
mozmanmozman
committed
remove manual signature overrides from .rst files
1 parent 99bf3c2 commit 2917269

File tree

6 files changed

+378
-246
lines changed

6 files changed

+378
-246
lines changed

‎docs/Makefile.linux‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14+
15+
# Disable C-extensions:
16+
# The Cython extension types replace the Python classes and do not have doc strings.
17+
export EZDXF_DISABLE_C_EXT=1
18+
19+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
20+
21+
help:
22+
@echo "Please use \`make <target>' where <target> is one of"
23+
@echo " html to make standalone HTML files"
24+
@echo " dirhtml to make HTML files named index.html in directories"
25+
@echo " singlehtml to make a single large HTML file"
26+
@echo " pickle to make pickle files"
27+
@echo " json to make JSON files"
28+
@echo " htmlhelp to make HTML files and a HTML help project"
29+
@echo " qthelp to make HTML files and a qthelp project"
30+
@echo " devhelp to make HTML files and a Devhelp project"
31+
@echo " epub to make an epub"
32+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
33+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
34+
@echo " text to make text files"
35+
@echo " man to make manual pages"
36+
@echo " changes to make an overview of all changed/added/deprecated items"
37+
@echo " linkcheck to check all external links for integrity"
38+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
39+
40+
clean:
41+
-rm -rf $(BUILDDIR)/*
42+
43+
html:
44+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
45+
@echo
46+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
47+
48+
dirhtml:
49+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
50+
@echo
51+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
52+
53+
singlehtml:
54+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
55+
@echo
56+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
57+
58+
pickle:
59+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
60+
@echo
61+
@echo "Build finished; now you can process the pickle files."
62+
63+
json:
64+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
65+
@echo
66+
@echo "Build finished; now you can process the JSON files."
67+
68+
htmlhelp:
69+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
70+
@echo
71+
@echo "Build finished; now you can run HTML Help Workshop with the" \
72+
".hhp project file in $(BUILDDIR)/htmlhelp."
73+
74+
qthelp:
75+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
76+
@echo
77+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
78+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
79+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ezdxf.qhcp"
80+
@echo "To view the help file:"
81+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ezdxf.qhc"
82+
83+
devhelp:
84+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
85+
@echo
86+
@echo "Build finished."
87+
@echo "To view the help file:"
88+
@echo "# mkdir -p $$HOME/.local/share/devhelp/ezdxf"
89+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ezdxf"
90+
@echo "# devhelp"
91+
92+
epub:
93+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
94+
@echo
95+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
96+
97+
latex:
98+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
99+
@echo
100+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
101+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
102+
"(use \`make latexpdf' here to do that automatically)."
103+
104+
latexpdf:
105+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
106+
@echo "Running LaTeX files through pdflatex..."
107+
make -C $(BUILDDIR)/latex all-pdf
108+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
109+
110+
text:
111+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
112+
@echo
113+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
114+
115+
man:
116+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
117+
@echo
118+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
119+
120+
changes:
121+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
122+
@echo
123+
@echo "The overview file is in $(BUILDDIR)/changes."
124+
125+
linkcheck:
126+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
127+
@echo
128+
@echo "Link check complete; look for any errors in the above output " \
129+
"or in $(BUILDDIR)/linkcheck/output.txt."
130+
131+
doctest:
132+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
133+
@echo "Testing of doctests in the sources finished, look at the " \
134+
"results in $(BUILDDIR)/doctest/output.txt."

‎docs/source/appsettings.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ Restore the WCS
5454
Update Extents
5555
--------------
5656

57-
.. autofunction:: update_extents(doc: Drawing) -> BoundingBox
57+
.. autofunction:: update_extents

‎docs/source/bbox.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ Example usage with caching:
5656
Functions
5757
---------
5858

59-
.. autofunction:: extents(entities: Iterable[DXFEntity], *, flatten=0.01, cache: Cache=None) -> BoundingBox
59+
.. autofunction:: extents
6060

61-
.. autofunction:: multi_flat(entities: Iterable[DXFEntity], *, flatten=0.01, cache: Cache=None) -> Iterable[BoundingBox]
61+
.. autofunction:: multi_flat
6262

63-
.. autofunction:: multi_recursive(entities: Iterable[DXFEntity], *, flatten=0.01, cache: Cache=None) -> Iterable[BoundingBox]
63+
.. autofunction:: multi_recursive
6464

6565
Caching Strategies
6666
------------------

‎docs/source/disassemble.rst‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ global option::
5656
Flatten Complex DXF Entities
5757
----------------------------
5858

59-
.. autofunction:: recursive_decompose(entities: Iterable[DXFEntity]) -> Iterable[DXFEntity]
59+
.. autofunction:: recursive_decompose
6060

6161
Entity Deconstruction
6262
---------------------
@@ -65,17 +65,17 @@ These functions disassemble DXF entities into simple geometric objects
6565
like meshes, paths or vertices. The :class:`Primitive` is a simplified
6666
intermediate class to use a common interface on various DXF entities.
6767

68-
.. autofunction:: make_primitive(entity: DXFEntity, max_flattening_distance=None) -> Primitive
68+
.. autofunction:: make_primitive
6969

70-
.. autofunction:: to_primitives(entities: Iterable[DXFEntity], max_flattening_distance: float = None) -> Iterable[Primitive]
70+
.. autofunction:: to_primitives
7171

72-
.. autofunction:: to_meshes(primitives: Iterable[Primitive]) -> Iterable[MeshBuilder]
72+
.. autofunction:: to_meshes
7373

74-
.. autofunction:: to_paths(primitives: Iterable[Primitive]) -> Iterable[Path]
74+
.. autofunction:: to_paths
7575

76-
.. autofunction:: to_vertices(primitives: Iterable[Primitive]) -> Iterable[Vec3]
76+
.. autofunction:: to_vertices
7777

78-
.. autofunction:: to_control_vertices(primitives: Iterable[Primitive]) -> Iterable[Vec3]
78+
.. autofunction:: to_control_vertices
7979

8080
.. class:: Primitive
8181

@@ -97,6 +97,4 @@ intermediate class to use a common interface on various DXF entities.
9797

9898
.. autoproperty:: is_empty
9999

100-
.. automethod:: vertices() -> Iterable[Vec3]
101-
102-
100+
.. automethod:: vertices

‎docs/source/groups.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ DXFGroup
2929

3030
.. attribute:: dxf.unnamed
3131

32-
``1`` for unnamed, ``0`` for named group (int)
32+
1 for unnamed, 0 for named group (int)
3333

3434
.. attribute:: dxf.selectable
3535

36-
``1`` for selectable, ``0`` for not selectable group (int)
36+
1 for selectable, 0 for not selectable group (int)
3737

3838
.. automethod:: __iter__
3939

@@ -65,17 +65,17 @@ by the attribute :attr:`~ezdxf.document.Drawing.groups`.
6565

6666
Manages all :class:`DXFGroup` objects of a :class:`~ezdxf.document.Drawing`.
6767

68-
.. method:: __len__() -> int
68+
.. method:: __len__
6969

7070
Returns the count of DXF groups.
7171

72-
.. method:: __iter__()
72+
.. method:: __iter__
7373

7474
Iterate over all existing groups as (`name`, `group`) tuples. `name` is
7575
the name of the group as string and `group` is an :class:`DXFGroup`
7676
object.
7777

78-
.. method:: __contains__(name: str) -> bool
78+
.. method:: __contains__
7979

8080
Returns ``True`` if a group `name` exist.
8181

@@ -84,13 +84,13 @@ by the attribute :attr:`~ezdxf.document.Drawing.groups`.
8484
Returns the group `name`. Raises :class:`DXFKeyError` if group `name`
8585
does not exist.
8686

87-
.. automethod:: groups() -> DXFGroup
87+
.. automethod:: groups
8888

89-
.. automethod:: new(name: str=None, description: str='', selectable: bool=True) -> DXFGroup
89+
.. automethod:: new
9090

91-
.. automethod:: delete(group: Union[DXFGroup, str]) -> None
91+
.. automethod:: delete
9292

93-
.. method:: clear()
93+
.. method:: clear
9494

9595
Delete all groups.
9696

0 commit comments

Comments
 (0)