-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# New Features * Added news section at the documentation landing page. * Added Jinja template for autoapi to change the class documentation layout. # Changes * Bumped dependencies. * Removed Work-in-Progress banner. * Changed package state from `alpha` to `stable`. * Updated PR template. # Bug Fixes * Fixed some typos. ------------------- # Related PRs: * pyTooling/Actions#39 (dependency)
- Loading branch information
Showing
16 changed files
with
219 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,29 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: pip | ||
| directory: "/" | ||
| target-branch: dev | ||
| commit-message: | ||
| prefix: "[Dependabot]" | ||
| labels: | ||
| # Maintain Python packages | ||
| - package-ecosystem: "pip" | ||
| directory: "/" | ||
| target-branch: dev | ||
| commit-message: | ||
| prefix: "[Dependabot]" | ||
| labels: | ||
| - Dependencies | ||
| assignees: | ||
| - Paebbels | ||
| reviewers: | ||
| - Paebbels | ||
| schedule: | ||
| interval: daily | ||
| reviewers: | ||
| - Paebbels | ||
| - Umarcor | ||
| schedule: | ||
| interval: "daily" # Checks on Monday trough Friday. | ||
|
|
||
| # Maintain GitHub Action runners | ||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| target-branch: dev | ||
| commit-message: | ||
| prefix: "[Dependabot]" | ||
| labels: | ||
| - Dependencies | ||
| reviewers: | ||
| - Paebbels | ||
| - Umarcor | ||
| schedule: | ||
| interval: "weekly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| # New Features | ||
|
|
||
| * tbd | ||
|
|
||
| # Changes | ||
|
|
@@ -9,3 +9,8 @@ | |
| # Bug Fixes | ||
|
|
||
| * tbd | ||
|
|
||
| ---------- | ||
| # Related PRs: | ||
|
|
||
| * tbd | ||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| .. # Template modified by Patrick Lehmann | ||
| * removed automodule on top, because private members are activated for autodoc (no doubled documentation). | ||
| * Made sections like 'submodules' bold text, but no headlines to reduce number of ToC levels. | ||
| =={{ '=' * node.name|length }}== | ||
| ``{{ node.name }}`` | ||
| =={{ '=' * node.name|length }}== | ||
|
|
||
| {##} | ||
| {%- block modules -%} | ||
| {%- if subnodes %} | ||
|
|
||
| **Submodules** | ||
|
|
||
|
|
||
| .. toctree:: | ||
| {% for item in subnodes %} | ||
| {{ item.name }} | ||
| {%- endfor %} | ||
| {##} | ||
| {%- endif -%} | ||
| {%- endblock -%} | ||
| {##} | ||
| .. currentmodule:: {{ node.name }} | ||
| {##} | ||
| {%- block functions -%} | ||
| {%- if node.functions %} | ||
|
|
||
| **Functions** | ||
|
|
||
| {% for item, obj in node.functions.items() -%} | ||
| - :py:func:`{{ item }}`: | ||
| {{ obj|summary }} | ||
|
|
||
| {% endfor -%} | ||
|
|
||
| {% for item in node.functions %} | ||
| .. autofunction:: {{ item }} | ||
| {##} | ||
| {%- endfor -%} | ||
| {%- endif -%} | ||
| {%- endblock -%} | ||
|
|
||
| {%- block classes -%} | ||
| {%- if node.classes %} | ||
|
|
||
| **Classes** | ||
|
|
||
| {% for item, obj in node.classes.items() -%} | ||
| - :py:class:`{{ item }}`: | ||
| {{ obj|summary }} | ||
|
|
||
| {% endfor -%} | ||
|
|
||
| {% for item in node.classes %} | ||
| .. autoclass:: {{ item }} | ||
| :members: | ||
|
|
||
| .. rubric:: Inheritance | ||
| .. inheritance-diagram:: {{ item }} | ||
| :parts: 1 | ||
| {##} | ||
| {%- endfor -%} | ||
| {%- endif -%} | ||
| {%- endblock -%} | ||
|
|
||
| {%- block exceptions -%} | ||
| {%- if node.exceptions %} | ||
|
|
||
| **Exceptions** | ||
|
|
||
| {% for item, obj in node.exceptions.items() -%} | ||
| - :py:exc:`{{ item }}`: | ||
| {{ obj|summary }} | ||
|
|
||
| {% endfor -%} | ||
|
|
||
| {% for item in node.exceptions %} | ||
| .. autoexception:: {{ item }} | ||
|
|
||
| .. rubric:: Inheritance | ||
| .. inheritance-diagram:: {{ item }} | ||
| :parts: 1 | ||
| {##} | ||
| {%- endfor -%} | ||
| {%- endif -%} | ||
| {%- endblock -%} | ||
|
|
||
| {%- block variables -%} | ||
| {%- if node.variables %} | ||
|
|
||
| **Variables** | ||
|
|
||
| {% for item, obj in node.variables.items() -%} | ||
| - :py:data:`{{ item }}` | ||
| {% endfor -%} | ||
|
|
||
| {% for item, obj in node.variables.items() %} | ||
| .. autodata:: {{ item }} | ||
| :annotation: | ||
|
|
||
| .. code-block:: text | ||
| {{ obj|pprint|indent(6) }} | ||
| {##} | ||
| {%- endfor -%} | ||
| {%- endif -%} | ||
| {%- endblock -%} |
Oops, something went wrong.