We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent e463f6f commit 37fd6bbCopy full SHA for 37fd6bb
4 files changed
documentation/api.rst
@@ -27,7 +27,26 @@ API
27
Package ``emcdproj``
28
===============================================================================
29
30
-.. todo:: Provide package description.
+Utilities for managing projects generated from the `emcd/python-project-common
31
+<https://github.com/emcd/python-project-common>`_ Copier template.
32
+
33
34
+Module ``emcdproj.website``
35
+-------------------------------------------------------------------------------
36
37
+.. automodule:: emcdproj.website
38
39
40
+Module ``emcdproj.filesystem``
41
42
43
+.. automodule:: emcdproj.filesystem
44
45
46
+Module ``emcdproj.interfaces``
47
48
49
+.. automodule:: emcdproj.interfaces
50
51
52
Module ``emcdproj.exceptions``
documentation/conf.py
@@ -79,8 +79,21 @@ def _import_version( ):
79
"v, remove specified key and return the corresponding value." ),
80
# Type annotation weirdnesses.
81
( 'py:class', "Doc" ),
82
+ ( 'py:class', "Positional" ),
83
+ ( 'py:class', "absence.objects.AbsentSingleton" ),
84
+ ( 'py:class', "emcdproj.__.state.Globals" ),
85
+ ( 'py:class', "frigid.classes.Class" ),
86
+ ( 'py:class', "frigid.classes.Dataclass" ),
87
+ ( 'py:class', "frigid.classes.ProtocolDataclass" ),
88
+ ( 'py:class', "platformdirs.unix.Unix" ),
89
( 'py:class', "types.Annotated" ),
90
( 'py:class', "typing_extensions.Any" ),
91
+ ( 'py:class', "typing_extensions.Self" ),
92
+ ( 'py:class', "typing_extensions.TypeIs" ),
93
+ ( 'py:class', "tyro.conf._markers.CallableType" ),
94
+]
95
+nitpick_ignore_regex = [
96
+ ( 'py:class', r'''.*\.Annotated\[.*?\]''' ),
97
]
98
99
# -- Options for linkcheck builder -------------------------------------------
documentation/devapi.rst
@@ -20,12 +20,17 @@
20
:tocdepth: 3
21
22
23
+*******************************************************************************
24
Internal Development Interface
25
26
+Package ``emdproj.__``
-Module ``emcdproj.__``
+Module ``emcdproj.__.imports``
-------------------------------------------------------------------------------
-.. .. automodule:: emcdproj.__
-.. :ignore-module-all: true
+.. automodule:: emcdproj.__.imports
+ :exclude-members: immutable
template/documentation/devapi.rst.jinja
@@ -1,5 +1,5 @@
1
-.. vim: set fileencoding=utf-8:
2
-.. -*- coding: utf-8 -*-
+.. vim: set filetype=rst fileencoding=utf-8:
+.. -*- mode: rst ; coding: utf-8 -*-
3
.. +--------------------------------------------------------------------------+
4
| |
5
| Licensed under the Apache License, Version 2.0 (the "License"); |
@@ -20,12 +20,16 @@
+Package ``{{ package_name }}.__``
-Module ``{{ package_name }}.__``
+Module ``{{ package_name }}.__.imports``
-.. automodule:: {{ package_name }}.__
- :ignore-module-all: true
+.. automodule:: {{ package_name }}.__.imports
0 commit comments