Merge pull request #68 from mosbth/pydoc

Add code and api documentation using pdoc
mosbth · Oct 3, 2024 · e6758c7 · e6758c7
2 parents a29b47a + d6413cf
commit e6758c7
Show file tree

Hide file tree

Showing 13 changed files with 9,908 additions and 0 deletions.
diff --git a/.requirements.txt b/.requirements.txt
@@ -12,3 +12,4 @@ coverage
 flake8
 flake8-docstrings
 pycodestyle
+pdoc
diff --git a/Makefile b/Makefile
@@ -150,6 +150,14 @@ coverage:
 
 
 
+# target: pdoc                - Create documentation of the code.
+.PHONY: pdoc
+pdoc:
+	@$(call MESSAGE,$@)
+	pdoc --output-dir docs/pdoc *.py
+
+
+
 # target: install-tools       - Install needed devtools.
 .PHONY: install-tools
 install-tools:

diff --git a/README.md b/README.md
@@ -98,6 +98,19 @@ Marvin will join your channel and then you can start playing.
 
 
 
+API documentation 
+--------------------------
+
+The code and API documentation is generated using pdoc and make.
+
+```bash
+make pdoc
+```
+
+The docs are saved at `docs/pdoc` and can be [viewed online](https://mosbth.github.io/irc2phpbb/pdoc/).
+
+
+
 History
 --------------------------
 The python script, `irc2phpbb.py`, is a implementation of an irc bot. The bot can answer 

diff --git a/docs/pdoc/bot.html b/docs/pdoc/bot.html
diff --git a/docs/pdoc/discord_bot.html b/docs/pdoc/discord_bot.html
diff --git a/docs/pdoc/index.html b/docs/pdoc/index.html
diff --git a/docs/pdoc/irc_bot.html b/docs/pdoc/irc_bot.html
diff --git a/docs/pdoc/main.html b/docs/pdoc/main.html
diff --git a/docs/pdoc/marvin_actions.html b/docs/pdoc/marvin_actions.html
diff --git a/docs/pdoc/marvin_general_actions.html b/docs/pdoc/marvin_general_actions.html
diff --git a/docs/pdoc/search.js b/docs/pdoc/search.js
diff --git a/docs/pdoc/test_main.html b/docs/pdoc/test_main.html
diff --git a/docs/pdoc/test_marvin_actions.html b/docs/pdoc/test_marvin_actions.html
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,3 +12,4 @@ coverage @@
     flake8
     flake8-docstrings
     pycodestyle
+    pdoc