Skip to content

Commit 00c0849

Browse files
soodokusoodoku
committed
fix docs
1 parent c7344fb commit 00c0849

File tree

6 files changed

+202
-6
lines changed

6 files changed

+202
-6
lines changed

‎docs/source/conf.py‎

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,27 @@
1111
# -- Project information -----------------------------------------------------
1212
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
1313

14-
project = 'piedomains'
15-
copyright = '2023, rajashekar chintalapati and gaurav sood'
16-
author = 'rajashekar chintalapati and gaurav sood'
17-
release = '0.3.10'
14+
import importlib.metadata
15+
import datetime
16+
17+
# Get metadata from package
18+
metadata = importlib.metadata.metadata('piedomains')
19+
project = metadata['Name']
20+
release = metadata['Version']
21+
22+
# Extract authors from metadata
23+
authors_list = []
24+
for author in metadata.get_all('Author') or []:
25+
authors_list.append(author)
26+
for author_email in metadata.get_all('Author-Email') or []:
27+
# Parse "Name <email>" format
28+
if '<' in author_email and '>' in author_email:
29+
name = author_email.split('<')[0].strip()
30+
if name:
31+
authors_list.append(name)
32+
33+
author = ', '.join(set(authors_list)) if authors_list else 'piedomains developers'
34+
copyright = f'{datetime.datetime.now().year}, {author}'
1835

1936
# -- General configuration ---------------------------------------------------
2037
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

‎docs/source/index.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Welcome to piedomains's documentation!
1212

1313
modules
1414

15-
.. include:: ../../README.rst
15+
.. include:: ../../README.md
16+
:parser: myst_parser.sphinx_
1617

1718
Indices and tables
1819
==================

‎docs/source/modules.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
piedomains
2-
============
2+
==========
33

44
.. toctree::
55
:maxdepth: 4
6+
7+
piedomains

‎docs/source/piedomains.classifiers.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
piedomains.classifiers package
2+
==============================
3+
4+
Submodules
5+
----------
6+
7+
piedomains.classifiers.combined\_classifier module
8+
--------------------------------------------------
9+
10+
.. automodule:: piedomains.classifiers.combined_classifier
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
piedomains.classifiers.image\_classifier module
16+
-----------------------------------------------
17+
18+
.. automodule:: piedomains.classifiers.image_classifier
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
piedomains.classifiers.text\_classifier module
24+
----------------------------------------------
25+
26+
.. automodule:: piedomains.classifiers.text_classifier
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: piedomains.classifiers
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:

‎docs/source/piedomains.processors.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
piedomains.processors package
2+
=============================
3+
4+
Submodules
5+
----------
6+
7+
piedomains.processors.content\_processor module
8+
-----------------------------------------------
9+
10+
.. automodule:: piedomains.processors.content_processor
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
piedomains.processors.text\_processor module
16+
--------------------------------------------
17+
18+
.. automodule:: piedomains.processors.text_processor
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: piedomains.processors
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:

‎docs/source/piedomains.rst‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
piedomains package
2+
==================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
piedomains.classifiers
11+
piedomains.processors
12+
13+
Submodules
14+
----------
15+
16+
piedomains.api module
17+
---------------------
18+
19+
.. automodule:: piedomains.api
20+
:members:
21+
:show-inheritance:
22+
:undoc-members:
23+
24+
piedomains.archive\_org\_downloader module
25+
------------------------------------------
26+
27+
.. automodule:: piedomains.archive_org_downloader
28+
:members:
29+
:show-inheritance:
30+
:undoc-members:
31+
32+
piedomains.base module
33+
----------------------
34+
35+
.. automodule:: piedomains.base
36+
:members:
37+
:show-inheritance:
38+
:undoc-members:
39+
40+
piedomains.config module
41+
------------------------
42+
43+
.. automodule:: piedomains.config
44+
:members:
45+
:show-inheritance:
46+
:undoc-members:
47+
48+
piedomains.constants module
49+
---------------------------
50+
51+
.. automodule:: piedomains.constants
52+
:members:
53+
:show-inheritance:
54+
:undoc-members:
55+
56+
piedomains.context\_managers module
57+
-----------------------------------
58+
59+
.. automodule:: piedomains.context_managers
60+
:members:
61+
:show-inheritance:
62+
:undoc-members:
63+
64+
piedomains.fetchers module
65+
--------------------------
66+
67+
.. automodule:: piedomains.fetchers
68+
:members:
69+
:show-inheritance:
70+
:undoc-members:
71+
72+
piedomains.http\_client module
73+
------------------------------
74+
75+
.. automodule:: piedomains.http_client
76+
:members:
77+
:show-inheritance:
78+
:undoc-members:
79+
80+
piedomains.logging module
81+
-------------------------
82+
83+
.. automodule:: piedomains.logging
84+
:members:
85+
:show-inheritance:
86+
:undoc-members:
87+
88+
piedomains.piedomain module
89+
---------------------------
90+
91+
.. automodule:: piedomains.piedomain
92+
:members:
93+
:show-inheritance:
94+
:undoc-members:
95+
96+
piedomains.utils module
97+
-----------------------
98+
99+
.. automodule:: piedomains.utils
100+
:members:
101+
:show-inheritance:
102+
:undoc-members:
103+
104+
Module contents
105+
---------------
106+
107+
.. automodule:: piedomains
108+
:members:
109+
:show-inheritance:
110+
:undoc-members:

0 commit comments

Comments
 (0)