summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Fischer <martin@push-f.com>2022-02-07 09:13:16 +0100
committerMartin Fischer <martin@push-f.com>2022-02-07 13:36:54 +0100
commitc5830b7a7606d76aaecbd496560cb85b0f931ffc (patch)
treeecd97b540ed27ba7f55b576c2b2e534c770ce51f
parenta26828bee90d7a7b01541315c43173b1b1a81223 (diff)
make docformat default to restructuredtext
-rw-r--r--overrides.toml2
-rwxr-xr-xpydoc.py7
2 files changed, 9 insertions, 0 deletions
diff --git a/overrides.toml b/overrides.toml
new file mode 100644
index 0000000..85a3d1f
--- /dev/null
+++ b/overrides.toml
@@ -0,0 +1,2 @@
+[docformat]
+pydoctor = "epytext"
diff --git a/pydoc.py b/pydoc.py
index 75777a3..8db292e 100755
--- a/pydoc.py
+++ b/pydoc.py
@@ -9,6 +9,7 @@ from typing import Dict, List
import pkg_resources
import pydoctor.driver
import requests
+import toml
# TODO: set USER_AGENT
@@ -99,6 +100,9 @@ if __name__ == '__main__':
shutil.rmtree(download_dir)
+ with open('overrides.toml') as f:
+ overrides = toml.load(f)
+
# 2. generate docs with pydoctor
dist = Path('dist')
@@ -127,12 +131,15 @@ if __name__ == '__main__':
f"[warning] found multiple packages for {package_name} ({packages}), we're just using the first one"
)
+ docformat = overrides['docformat'].get(package_name, 'restructuredtext')
+
out_dir.mkdir(parents=True)
pydoctor.driver.main(
# fmt: off
[
str(packages[0]),
'--html-output', out_dir,
+ '--docformat', docformat,
]
# fmt: on
)