Commit e758739d authored by Barkin Simsek's avatar Barkin Simsek 🐢
Browse files

Force regenerate documentation from docstrings

parent ba2727a8
Pipeline #7429 passed with stages
in 2 minutes and 38 seconds
......@@ -25,7 +25,7 @@ pages:
script:
- pip install -U sphinx
- pip install -e src/
- sphinx-apidoc -o ./docs/sphinx/ ./src/captchamonitor/
- sphinx-apidoc -f -o ./docs/sphinx/ ./src/captchamonitor/
- sphinx-build -b html ./docs/sphinx/ public
artifacts:
paths:
......
......@@ -38,7 +38,7 @@ docs: check_non_root FORCE
@echo "\e[93m>> Installing the package\e[0m"
pip3 install -e src/
@echo "\n\e[93m>> Generating documentation from docstrings\e[0m"
sphinx-apidoc -o ./docs/sphinx/ ./src/captchamonitor/
sphinx-apidoc -f -o ./docs/sphinx/ ./src/captchamonitor/
@echo "\n\e[93m>> Building the documentation\e[0m"
sphinx-build -b html ./docs/sphinx/ public
@echo "\n\e[92m>> Done!\e[0m"
......
......@@ -4,6 +4,46 @@ captchamonitor.core package
Submodules
----------
captchamonitor.core.analyzer module
-----------------------------------
.. automodule:: captchamonitor.core.analyzer
:members:
:undoc-members:
:show-inheritance:
captchamonitor.core.schedule\_jobs module
-----------------------------------------
.. automodule:: captchamonitor.core.schedule_jobs
:members:
:undoc-members:
:show-inheritance:
captchamonitor.core.update\_domains module
------------------------------------------
.. automodule:: captchamonitor.core.update_domains
:members:
:undoc-members:
:show-inheritance:
captchamonitor.core.update\_fetchers module
-------------------------------------------
.. automodule:: captchamonitor.core.update_fetchers
:members:
:undoc-members:
:show-inheritance:
captchamonitor.core.update\_relays module
-----------------------------------------
.. automodule:: captchamonitor.core.update_relays
:members:
:undoc-members:
:show-inheritance:
captchamonitor.core.worker module
---------------------------------
......
......@@ -28,6 +28,14 @@ captchamonitor.fetchers.firefox\_browser module
:undoc-members:
:show-inheritance:
captchamonitor.fetchers.opera\_browser module
---------------------------------------------
.. automodule:: captchamonitor.fetchers.opera_browser
:members:
:undoc-members:
:show-inheritance:
captchamonitor.fetchers.tor\_browser module
-------------------------------------------
......
......@@ -76,6 +76,14 @@ captchamonitor.utils.tor\_launcher module
:undoc-members:
:show-inheritance:
captchamonitor.utils.website\_parser module
-------------------------------------------
.. automodule:: captchamonitor.utils.website_parser
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment