From d5de55957401ef39e65d4a37e40da97f3a253e57 Mon Sep 17 00:00:00 2001 From: Romain Bignon Date: Tue, 29 Mar 2011 16:14:35 +0200 Subject: [PATCH] add a ugly tool to generate API documentation files --- .gitignore | 1 + docs/source/api/capabilities/account.rst | 6 ------ docs/source/api/capabilities/bank.rst | 6 ------ docs/source/api/capabilities/base.rst | 6 ------ docs/source/api/capabilities/chat.rst | 6 ------ docs/source/api/capabilities/contact.rst | 6 ------ docs/source/api/capabilities/content.rst | 6 ------ docs/source/api/capabilities/dating.rst | 6 ------ docs/source/api/capabilities/geolocip.rst | 6 ------ docs/source/api/capabilities/index.rst | 22 ---------------------- docs/source/api/capabilities/messages.rst | 6 ------ docs/source/api/capabilities/radio.rst | 6 ------ docs/source/api/capabilities/torrent.rst | 6 ------ docs/source/api/capabilities/travel.rst | 6 ------ docs/source/api/capabilities/video.rst | 6 ------ docs/source/api/capabilities/weather.rst | 6 ------ docs/source/api/core/backendscfg.rst | 6 ------ docs/source/api/core/bcall.rst | 6 ------ docs/source/api/core/index.rst | 13 ------------- docs/source/api/core/modules.rst | 6 ------ docs/source/api/core/ouiboube.rst | 6 ------ docs/source/api/core/scheduler.rst | 6 ------ docs/source/api/index.rst | 11 ----------- docs/source/api/tools/backend.rst | 6 ------ docs/source/api/tools/index.rst | 9 --------- docs/source/conf.py | 2 ++ 26 files changed, 3 insertions(+), 175 deletions(-) delete mode 100644 docs/source/api/capabilities/account.rst delete mode 100644 docs/source/api/capabilities/bank.rst delete mode 100644 docs/source/api/capabilities/base.rst delete mode 100644 docs/source/api/capabilities/chat.rst delete mode 100644 docs/source/api/capabilities/contact.rst delete mode 100644 docs/source/api/capabilities/content.rst delete mode 100644 docs/source/api/capabilities/dating.rst delete mode 100644 docs/source/api/capabilities/geolocip.rst delete mode 100644 docs/source/api/capabilities/index.rst delete mode 100644 docs/source/api/capabilities/messages.rst delete mode 100644 docs/source/api/capabilities/radio.rst delete mode 100644 docs/source/api/capabilities/torrent.rst delete mode 100644 docs/source/api/capabilities/travel.rst delete mode 100644 docs/source/api/capabilities/video.rst delete mode 100644 docs/source/api/capabilities/weather.rst delete mode 100644 docs/source/api/core/backendscfg.rst delete mode 100644 docs/source/api/core/bcall.rst delete mode 100644 docs/source/api/core/index.rst delete mode 100644 docs/source/api/core/modules.rst delete mode 100644 docs/source/api/core/ouiboube.rst delete mode 100644 docs/source/api/core/scheduler.rst delete mode 100644 docs/source/api/index.rst delete mode 100644 docs/source/api/tools/backend.rst delete mode 100644 docs/source/api/tools/index.rst diff --git a/.gitignore b/.gitignore index 5e5c64782a..485575da23 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ dist *.egg-info *~ tags +docs/source/api diff --git a/docs/source/api/capabilities/account.rst b/docs/source/api/capabilities/account.rst deleted file mode 100644 index 43a7ba6271..0000000000 --- a/docs/source/api/capabilities/account.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.account` -================================== - -.. automodule:: weboob.capabilities.account - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/bank.rst b/docs/source/api/capabilities/bank.rst deleted file mode 100644 index 497126ad0a..0000000000 --- a/docs/source/api/capabilities/bank.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.bank` -=============================== - -.. automodule:: weboob.capabilities.bank - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/base.rst b/docs/source/api/capabilities/base.rst deleted file mode 100644 index 1725e06f22..0000000000 --- a/docs/source/api/capabilities/base.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.base` -=============================== - -.. automodule:: weboob.capabilities.base - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/chat.rst b/docs/source/api/capabilities/chat.rst deleted file mode 100644 index 7c4f9569f5..0000000000 --- a/docs/source/api/capabilities/chat.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.chat` -=============================== - -.. automodule:: weboob.capabilities.chat - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/contact.rst b/docs/source/api/capabilities/contact.rst deleted file mode 100644 index 4a1e9970c3..0000000000 --- a/docs/source/api/capabilities/contact.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.contact` -================================== - -.. automodule:: weboob.capabilities.contact - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/content.rst b/docs/source/api/capabilities/content.rst deleted file mode 100644 index e1763b559f..0000000000 --- a/docs/source/api/capabilities/content.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.content` -================================== - -.. automodule:: weboob.capabilities.content - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/dating.rst b/docs/source/api/capabilities/dating.rst deleted file mode 100644 index 2897b99ee4..0000000000 --- a/docs/source/api/capabilities/dating.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.dating` -================================= - -.. automodule:: weboob.capabilities.dating - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/geolocip.rst b/docs/source/api/capabilities/geolocip.rst deleted file mode 100644 index d71b430b10..0000000000 --- a/docs/source/api/capabilities/geolocip.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.geolocip` -=================================== - -.. automodule:: weboob.capabilities.geolocip - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/index.rst b/docs/source/api/capabilities/index.rst deleted file mode 100644 index e365594728..0000000000 --- a/docs/source/api/capabilities/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -:mod:`weboob.capabilities` -========================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - account - bank - base - chat - contact - content - dating - geolocip - messages - radio - torrent - travel - video - weather diff --git a/docs/source/api/capabilities/messages.rst b/docs/source/api/capabilities/messages.rst deleted file mode 100644 index cc669db294..0000000000 --- a/docs/source/api/capabilities/messages.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.messages` -=================================== - -.. automodule:: weboob.capabilities.messages - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/radio.rst b/docs/source/api/capabilities/radio.rst deleted file mode 100644 index 645b98c332..0000000000 --- a/docs/source/api/capabilities/radio.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.radio` -================================ - -.. automodule:: weboob.capabilities.radio - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/torrent.rst b/docs/source/api/capabilities/torrent.rst deleted file mode 100644 index 3fe8c196c4..0000000000 --- a/docs/source/api/capabilities/torrent.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.torrent` -================================== - -.. automodule:: weboob.capabilities.torrent - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/travel.rst b/docs/source/api/capabilities/travel.rst deleted file mode 100644 index d00de5e370..0000000000 --- a/docs/source/api/capabilities/travel.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.travel` -================================= - -.. automodule:: weboob.capabilities.travel - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/video.rst b/docs/source/api/capabilities/video.rst deleted file mode 100644 index 55db098e7d..0000000000 --- a/docs/source/api/capabilities/video.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.video` -================================ - -.. automodule:: weboob.capabilities.video - :members: - :undoc-members: diff --git a/docs/source/api/capabilities/weather.rst b/docs/source/api/capabilities/weather.rst deleted file mode 100644 index 8a83482113..0000000000 --- a/docs/source/api/capabilities/weather.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.capabilities.weather` -================================== - -.. automodule:: weboob.capabilities.weather - :members: - :undoc-members: diff --git a/docs/source/api/core/backendscfg.rst b/docs/source/api/core/backendscfg.rst deleted file mode 100644 index b26f8a9b8a..0000000000 --- a/docs/source/api/core/backendscfg.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.core.backendscfg` -============================== - -.. automodule:: weboob.core.backendscfg - :members: - :undoc-members: diff --git a/docs/source/api/core/bcall.rst b/docs/source/api/core/bcall.rst deleted file mode 100644 index 51d173f3cf..0000000000 --- a/docs/source/api/core/bcall.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.core.bcall` -======================== - -.. automodule:: weboob.core.bcall - :members: - :undoc-members: diff --git a/docs/source/api/core/index.rst b/docs/source/api/core/index.rst deleted file mode 100644 index fd1dc57579..0000000000 --- a/docs/source/api/core/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -:mod:`weboob.core` -================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - backendscfg - bcall - modules - ouiboube - scheduler diff --git a/docs/source/api/core/modules.rst b/docs/source/api/core/modules.rst deleted file mode 100644 index 60ea3d14e2..0000000000 --- a/docs/source/api/core/modules.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.core.modules` -========================== - -.. automodule:: weboob.core.modules - :members: - :undoc-members: diff --git a/docs/source/api/core/ouiboube.rst b/docs/source/api/core/ouiboube.rst deleted file mode 100644 index 72e57cdc18..0000000000 --- a/docs/source/api/core/ouiboube.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.core.ouiboube` -=========================== - -.. automodule:: weboob.core.ouiboube - :members: - :undoc-members: diff --git a/docs/source/api/core/scheduler.rst b/docs/source/api/core/scheduler.rst deleted file mode 100644 index 10634f39cc..0000000000 --- a/docs/source/api/core/scheduler.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.core.scheduler` -============================ - -.. automodule:: weboob.core.scheduler - :members: - :undoc-members: diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst deleted file mode 100644 index a7d421eee3..0000000000 --- a/docs/source/api/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -API -=== - -Contents: - -.. toctree:: - :maxdepth: 2 - - capabilities/index - core/index - tools/index diff --git a/docs/source/api/tools/backend.rst b/docs/source/api/tools/backend.rst deleted file mode 100644 index b0792159b2..0000000000 --- a/docs/source/api/tools/backend.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`weboob.tools.backend` -=========================== - -.. automodule:: weboob.tools.backend - :members: - :undoc-members: diff --git a/docs/source/api/tools/index.rst b/docs/source/api/tools/index.rst deleted file mode 100644 index 0489b9f77e..0000000000 --- a/docs/source/api/tools/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -:mod:`weboob.tools` -=================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - backend diff --git a/docs/source/conf.py b/docs/source/conf.py index def7a90fb7..aec681b376 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -13,6 +13,8 @@ import sys, os +os.system('./genapi.py') + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -- GitLab