Skip to content

Commit 37fd6bb

Browse files
committed
Project: Documentation: Update and fix API documentation.
Also, * Copier Template: Documentation: Update internals documentation.
1 parent e463f6f commit 37fd6bb

4 files changed

Lines changed: 50 additions & 9 deletions

File tree

documentation/api.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,26 @@ API
2727
Package ``emcdproj``
2828
===============================================================================
2929

30-
.. todo:: Provide package description.
30+
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
3150

3251

3352
Module ``emcdproj.exceptions``

documentation/conf.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,21 @@ def _import_version( ):
7979
"v, remove specified key and return the corresponding value." ),
8080
# Type annotation weirdnesses.
8181
( '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" ),
8289
( 'py:class', "types.Annotated" ),
8390
( '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\[.*?\]''' ),
8497
]
8598

8699
# -- Options for linkcheck builder -------------------------------------------

documentation/devapi.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,17 @@
2020
:tocdepth: 3
2121

2222

23+
*******************************************************************************
2324
Internal Development Interface
25+
*******************************************************************************
26+
27+
28+
Package ``emdproj.__``
2429
===============================================================================
2530

2631

27-
Module ``emcdproj.__``
32+
Module ``emcdproj.__.imports``
2833
-------------------------------------------------------------------------------
2934

30-
.. .. automodule:: emcdproj.__
31-
.. :ignore-module-all: true
35+
.. automodule:: emcdproj.__.imports
36+
:exclude-members: immutable

template/documentation/devapi.rst.jinja

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
.. vim: set fileencoding=utf-8:
2-
.. -*- coding: utf-8 -*-
1+
.. vim: set filetype=rst fileencoding=utf-8:
2+
.. -*- mode: rst ; coding: utf-8 -*-
33
.. +--------------------------------------------------------------------------+
44
| |
55
| Licensed under the Apache License, Version 2.0 (the "License"); |
@@ -20,12 +20,16 @@
2020
:tocdepth: 3
2121

2222

23+
*******************************************************************************
2324
Internal Development Interface
25+
*******************************************************************************
26+
27+
28+
Package ``{{ package_name }}.__``
2429
===============================================================================
2530

2631

27-
Module ``{{ package_name }}.__``
32+
Module ``{{ package_name }}.__.imports``
2833
-------------------------------------------------------------------------------
2934

30-
.. automodule:: {{ package_name }}.__
31-
:ignore-module-all: true
35+
.. automodule:: {{ package_name }}.__.imports

0 commit comments

Comments
 (0)