Implement Octopoes Models documentation

.pre-commit-config.yaml

@@ -36,12 +36,12 @@ repos:
     files: pyproject.toml$
 
 - repo: https://github.com/rstcheck/rstcheck
-  rev: v6.2.0
+  rev: v6.2.1
   hooks:
   - id: rstcheck
     # https://github.com/rstcheck/rstcheck-core/issues/4
-    args: ["--ignore-messages", "Hyperlink target .* is not referenced", "--ignore-directives", "mermaid"]
-    additional_dependencies: ["rstcheck[sphinx]"]
+    args: ["--ignore-messages", "Hyperlink target .* is not referenced", "--ignore-directives", "mermaid,automodule"]
+    additional_dependencies: ["rstcheck[sphinx]", "autodoc-pydantic==2.1.0"]
 
 - repo: https://github.com/MarketSquare/robotframework-tidy
   rev: "4.11.0"

Makefile

@@ -113,7 +113,9 @@ docs:
 	$(call build-settings-doc,boefjes,boefjes.config,boefjes,Boefjes)
 	$(call build-settings-doc,bytes,bytes.config,bytes,Bytes)
 	$(call build-settings-doc,mula/scheduler,config.settings,mula,Mula)
-	sphinx-build -b html docs/source docs/_build
+
+	PYTHONPATH=$(PYTHONPATH):boefjes/:bytes/:keiko/:mula/:octopoes/ sphinx-build -b html docs/source docs/_build
+
 
 poetry-dependencies:
 	files=$$(find . -name pyproject.toml -maxdepth 2); \

docs/source/conf.py

@@ -25,9 +25,12 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.githubpages",
     "sphinx.ext.autosectionlabel",
+    "sphinx.ext.todo",
+    "sphinx.ext.autodoc",
     "sphinx_rtd_theme",
     "myst_parser",
     "sphinxcontrib.mermaid",
+    "sphinxcontrib.autodoc_pydantic",
 ]
 
 myst_enable_extensions = ["tasklist"]

docs/source/developer_documentation/index.rst

@@ -12,5 +12,6 @@ Contains documentation for developers and contributors.
    boefjes
    bytes
    octopoes
+   octopoes_models
    octopoes_research
    keiko

docs/source/developer_documentation/octopoes_models.rst

@@ -0,0 +1,80 @@
+Octopoes Models
+###############
+
+octopoes.models.ooi.service
+===========================
+
+.. automodule:: octopoes.models.ooi.service
+   :members:
+
+octopoes.models.ooi.findings
+============================
+
+.. automodule:: octopoes.models.ooi.findings
+   :members:
+
+octopoes.models.ooi.email_security
+==================================
+
+.. automodule:: octopoes.models.ooi.email_security
+   :members:
+
+octopoes.models.ooi.web
+=======================
+
+.. automodule:: octopoes.models.ooi.web
+   :members:
+
+octopoes.models.ooi.config
+==========================
+
+.. automodule:: octopoes.models.ooi.config
+   :members:
+
+octopoes.models.ooi.certificate
+===============================
+
+.. automodule:: octopoes.models.ooi.certificate
+   :members:
+
+octopoes.models.ooi.monitoring
+==============================
+
+.. automodule:: octopoes.models.ooi.monitoring
+   :members:
+
+octopoes.models.ooi.question
+============================
+
+.. automodule:: octopoes.models.ooi.question
+   :members:
+
+octopoes.models.ooi.network
+================================
+
+.. automodule:: octopoes.models.ooi.network
+   :members:
+
+octopoes.models.ooi.reports
+===========================
+
+.. automodule:: octopoes.models.ooi.reports
+   :members:
+
+octopoes.models.ooi.dns.records
+===============================
+
+.. automodule:: octopoes.models.ooi.dns.records
+   :members:
+
+octopoes.models.ooi.dns.zone
+============================
+
+.. automodule:: octopoes.models.ooi.dns.zone
+   :members:
+
+octopoes.models.ooi.software
+============================
+
+.. automodule:: octopoes.models.ooi.software
+   :members:

pyproject.toml

@@ -104,5 +104,6 @@ sphinx = "<8"
 sphinx_rtd_theme = "2.0.0"
 sphinxcontrib-mermaid = "^0.9.2"
 myst-parser = "^2.0.0"
-settings-doc = "^4.0.0"
+settings-doc = "^4.0.1"
 colorama = "0.4.6" # Required on all platforms, not just win32
+autodoc-pydantic = "^2.1.0"

requirements.txt

@@ -4,6 +4,9 @@ alabaster==0.7.16 ; python_version >= "3.10" and python_version < "4.0" \
 annotated-types==0.6.0 ; python_version >= "3.10" and python_version < "4.0" \
     --hash=sha256:0641064de18ba7a25dee8f96403ebc39113d0cb953a01429249d5c7564666a43 \
     --hash=sha256:563339e807e53ffd9c267e99fc6d9ea23eb8443c08f112651963e24e22f84a5d
+autodoc-pydantic==2.1.0 ; python_version >= "3.10" and python_version < "4.0" \
+    --hash=sha256:3cf1b973e2f5ff0fbbe9b951c11827b5e32d3409e238f7f5782359426ab8d360 \
+    --hash=sha256:9f1f82ee3667589dfa08b21697be8bbd80b15110e838cd765bb1bf3ce1b0ea8f
 babel==2.14.0 ; python_version >= "3.10" and python_version < "4.0" \
     --hash=sha256:6919867db036398ba21eb5c7a0f6b28ab8cbc3ae7a73a44ebe34ae74a4e7d363 \
     --hash=sha256:efb1a25b7118e67ce3a259bed20545c29cb68be8ad2c784c83689981b7a57287
@@ -344,9 +347,9 @@ requests==2.31.0 ; python_version >= "3.10" and python_version < "4.0" \
 rich==13.7.0 ; python_version >= "3.10" and python_version < "4.0" \
     --hash=sha256:5cb5123b5cf9ee70584244246816e9114227e0b98ad9176eede6ad54bf5403fa \
     --hash=sha256:6da14c108c4866ee9520bbffa71f6fe3962e193b7da68720583850cd4548e235
-settings-doc==4.0.0 ; python_version >= "3.10" and python_version < "4.0" \
-    --hash=sha256:2b6cc1529707ebf1e47c655b7e4f190254e9b3784b87b5c2cb7174346694e921 \
-    --hash=sha256:89542f8165ecc3e72b8d8241d6d83034ca824e890c961c935e38d5c15b75b582
+settings-doc==4.0.1 ; python_version >= "3.10" and python_version < "4.0" \
+    --hash=sha256:3130ebf535b5be926ba830746fd085dac59e8fb0a5042f44c0216d6d7e69a2ae \
+    --hash=sha256:773248f54408d0e523978ee1729a449a635cb88c2a3cb72998f5b653cf80f334
 shellingham==1.5.4 ; python_version >= "3.10" and python_version < "4.0" \
     --hash=sha256:7ecfff8f2fd72616f7481040475a65b2bf8af90a56c89140852d1120324e8686 \
     --hash=sha256:8dbca0739d487e5bd35ab3ca4b36e11c4078f3a234bfce294b0a0291363404de