+
Skip to content

FIX: Fixed up layout doc. Updated conf.py. #505

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 28, 2025
Merged

FIX: Fixed up layout doc. Updated conf.py. #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/source/api/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Glossary

Each zone contains a subset of layers available to the entire circuit board and is spatially defined by polygons on the Outline layer.

All zones (except the "fixed" zone) can have bends applied to them by defining :class:`BoardBendDefs <ansys.edb.core.primitive.board_bend_def.BoardBendDef>` on zone primitives.

ValueLike

Any of the following data types that represents a numeric value
Expand Down Expand Up @@ -52,6 +54,15 @@ Glossary

(:term:`Point3DLike`, :term:`Point3DLike`, :term:`Point3DLike`)


LayerLike

Any of the following data types that represent a layer.

- :obj:`str`
- :class:`Layer <ansys.edb.core.layer.layer.Layer>`


RoughnessModel

A Groisse roughness model is represented by a single value containing the roughness value.
Expand Down
1 change: 1 addition & 0 deletions doc/source/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _ref_index_api:

=============
API reference

Check warning on line 4 in doc/source/api/index.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/index.rst#L4 

[Google.Headings] 'API reference' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'API reference' should use sentence-style capitalization.", "location": {"path": "doc/source/api/index.rst", "range": {"start": {"line": 4, "column": 1}}}, "severity": "WARNING"}
=============

This section describes all API classes, functions, and attributes in PyEDB-Core modules.
Expand All @@ -27,3 +27,4 @@
terminal
utility
release_notes
glossary
6 changes: 5 additions & 1 deletion doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@
# numpydoc configuration
numpydoc_show_class_members = False
numpydoc_xref_param_type = True
numpydoc_xref_ignore = {"of"}

# Consider enabling numpydoc validation. See:
# https://numpydoc.readthedocs.io/en/latest/validation.html#
Expand All @@ -98,7 +99,7 @@
"GL09", # Deprecation warning should precede extended summary
"GL10", # reST directives {directives} must be followed by two colons
"SS01", # No summary found
"SS02", # Summary does not start with a capital letter
# "SS02", # Summary does not start with a capital letter
# "SS03", # Summary does not end with a period
"SS04", # Summary contains heading whitespaces
# "SS05", # Summary must start with infinitive verb, not third person
Expand All @@ -121,3 +122,6 @@

# Ignore the following links during link checking
linkcheck_ignore = ["https://www.ansys.com/products/electronics"]

# Ignore type hints in documentation (they are only used for code completion)
autodoc_typehints = "none"
Loading
Loading
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载