diff --git a/docs/index.rst b/docs/index.rst index ec585a5..22ff84d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,9 +21,9 @@ Contents ======== .. toctree:: - :caption: Contribute + :caption: API Reference - api/index + reference/icalendar .. toctree:: diff --git a/docs/reference/api.rst b/docs/reference/api.rst deleted file mode 100644 index 86790d7..0000000 --- a/docs/reference/api.rst +++ /dev/null @@ -1,92 +0,0 @@ -API Reference -------------- - -icalendar.attr -++++++++++++++ - -.. automodule:: icalendar.attr - :members: - -icalendar.alarms -++++++++++++++++ - -.. automodule:: icalendar.alarms - :members: - -icalendar.cal -+++++++++++++ - -.. automodule:: icalendar.cal - :members: - -icalendar.caselessdict -++++++++++++++++++++++ - -.. automodule:: icalendar.caselessdict - :members: - -icalendar.cli -+++++++++++++ - -.. automodule:: icalendar.cli - :members: - -icalendar.enums -+++++++++++++++ - -.. automodule:: icalendar.enums - :members: - -icalendar.error -+++++++++++++++ - -.. automodule:: icalendar.error - :members: - -icalendar.param -+++++++++++++++ - -.. automodule:: icalendar.param - :members: - -icalendar.parser -++++++++++++++++ - -.. automodule:: icalendar.parser - :members: - -icalendar.parser_tools -++++++++++++++++++++++ - -.. automodule:: icalendar.parser_tools - :members: - -icalendar.prop -++++++++++++++ - -.. automodule:: icalendar.prop - :members: - -icalendar.tools -+++++++++++++++ - -.. automodule:: icalendar.tools - :members: - -icalendar.timezone -++++++++++++++++++ - -.. automodule:: icalendar.timezone - :members: - -.. automodule:: icalendar.timezone.tzid - :members: - -.. automodule:: icalendar.timezone.tzp - :members: - -icalendar.version -+++++++++++++++++ - -.. automodule:: icalendar.version - :members: diff --git a/docs/reference/icalendar.alarms.rst b/docs/reference/icalendar.alarms.rst new file mode 100644 index 0000000..7847980 --- /dev/null +++ b/docs/reference/icalendar.alarms.rst @@ -0,0 +1,7 @@ +icalendar.alarms module +======================= + +.. automodule:: icalendar.alarms + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.attr.rst b/docs/reference/icalendar.attr.rst new file mode 100644 index 0000000..6a5892f --- /dev/null +++ b/docs/reference/icalendar.attr.rst @@ -0,0 +1,7 @@ +icalendar.attr module +===================== + +.. automodule:: icalendar.attr + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.cal.rst b/docs/reference/icalendar.cal.rst new file mode 100644 index 0000000..fc2dd5f --- /dev/null +++ b/docs/reference/icalendar.cal.rst @@ -0,0 +1,7 @@ +icalendar.cal module +==================== + +.. automodule:: icalendar.cal + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.caselessdict.rst b/docs/reference/icalendar.caselessdict.rst new file mode 100644 index 0000000..1ae0369 --- /dev/null +++ b/docs/reference/icalendar.caselessdict.rst @@ -0,0 +1,7 @@ +icalendar.caselessdict module +============================= + +.. automodule:: icalendar.caselessdict + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.cli.rst b/docs/reference/icalendar.cli.rst new file mode 100644 index 0000000..da5fc27 --- /dev/null +++ b/docs/reference/icalendar.cli.rst @@ -0,0 +1,7 @@ +icalendar.cli module +==================== + +.. automodule:: icalendar.cli + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.enums.rst b/docs/reference/icalendar.enums.rst new file mode 100644 index 0000000..3ec8d54 --- /dev/null +++ b/docs/reference/icalendar.enums.rst @@ -0,0 +1,7 @@ +icalendar.enums module +====================== + +.. automodule:: icalendar.enums + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.error.rst b/docs/reference/icalendar.error.rst new file mode 100644 index 0000000..a3b768c --- /dev/null +++ b/docs/reference/icalendar.error.rst @@ -0,0 +1,7 @@ +icalendar.error module +====================== + +.. automodule:: icalendar.error + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.param.rst b/docs/reference/icalendar.param.rst new file mode 100644 index 0000000..0874260 --- /dev/null +++ b/docs/reference/icalendar.param.rst @@ -0,0 +1,7 @@ +icalendar.param module +====================== + +.. automodule:: icalendar.param + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.parser.rst b/docs/reference/icalendar.parser.rst new file mode 100644 index 0000000..6b006df --- /dev/null +++ b/docs/reference/icalendar.parser.rst @@ -0,0 +1,7 @@ +icalendar.parser module +======================= + +.. automodule:: icalendar.parser + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.parser_tools.rst b/docs/reference/icalendar.parser_tools.rst new file mode 100644 index 0000000..8e566d2 --- /dev/null +++ b/docs/reference/icalendar.parser_tools.rst @@ -0,0 +1,7 @@ +icalendar.parser\_tools module +============================== + +.. automodule:: icalendar.parser_tools + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.prop.rst b/docs/reference/icalendar.prop.rst new file mode 100644 index 0000000..a8a712d --- /dev/null +++ b/docs/reference/icalendar.prop.rst @@ -0,0 +1,7 @@ +icalendar.prop module +===================== + +.. automodule:: icalendar.prop + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.rst b/docs/reference/icalendar.rst new file mode 100644 index 0000000..4078f8f --- /dev/null +++ b/docs/reference/icalendar.rst @@ -0,0 +1,35 @@ +icalendar package +================= + +.. automodule:: icalendar + :members: + :show-inheritance: + :undoc-members: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + icalendar.timezone + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + icalendar.alarms + icalendar.attr + icalendar.cal + icalendar.caselessdict + icalendar.cli + icalendar.enums + icalendar.error + icalendar.param + icalendar.parser + icalendar.parser_tools + icalendar.prop + icalendar.tools + icalendar.version diff --git a/docs/reference/icalendar.timezone.equivalent_timezone_ids.rst b/docs/reference/icalendar.timezone.equivalent_timezone_ids.rst new file mode 100644 index 0000000..ed8c3b8 --- /dev/null +++ b/docs/reference/icalendar.timezone.equivalent_timezone_ids.rst @@ -0,0 +1,7 @@ +icalendar.timezone.equivalent\_timezone\_ids module +=================================================== + +.. automodule:: icalendar.timezone.equivalent_timezone_ids + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.timezone.equivalent_timezone_ids_result.rst b/docs/reference/icalendar.timezone.equivalent_timezone_ids_result.rst new file mode 100644 index 0000000..05a12d2 --- /dev/null +++ b/docs/reference/icalendar.timezone.equivalent_timezone_ids_result.rst @@ -0,0 +1,7 @@ +icalendar.timezone.equivalent\_timezone\_ids\_result module +=========================================================== + +.. automodule:: icalendar.timezone.equivalent_timezone_ids_result + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.timezone.provider.rst b/docs/reference/icalendar.timezone.provider.rst new file mode 100644 index 0000000..5dc95c1 --- /dev/null +++ b/docs/reference/icalendar.timezone.provider.rst @@ -0,0 +1,7 @@ +icalendar.timezone.provider module +================================== + +.. automodule:: icalendar.timezone.provider + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.timezone.pytz.rst b/docs/reference/icalendar.timezone.pytz.rst new file mode 100644 index 0000000..2f9eba5 --- /dev/null +++ b/docs/reference/icalendar.timezone.pytz.rst @@ -0,0 +1,7 @@ +icalendar.timezone.pytz module +============================== + +.. automodule:: icalendar.timezone.pytz + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.timezone.rst b/docs/reference/icalendar.timezone.rst new file mode 100644 index 0000000..193f551 --- /dev/null +++ b/docs/reference/icalendar.timezone.rst @@ -0,0 +1,22 @@ +icalendar.timezone package +========================== + +.. automodule:: icalendar.timezone + :members: + :show-inheritance: + :undoc-members: + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + icalendar.timezone.equivalent_timezone_ids + icalendar.timezone.equivalent_timezone_ids_result + icalendar.timezone.provider + icalendar.timezone.pytz + icalendar.timezone.tzid + icalendar.timezone.tzp + icalendar.timezone.windows_to_olson + icalendar.timezone.zoneinfo diff --git a/docs/reference/icalendar.timezone.tzid.rst b/docs/reference/icalendar.timezone.tzid.rst new file mode 100644 index 0000000..b76e3cd --- /dev/null +++ b/docs/reference/icalendar.timezone.tzid.rst @@ -0,0 +1,7 @@ +icalendar.timezone.tzid module +============================== + +.. automodule:: icalendar.timezone.tzid + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.timezone.tzp.rst b/docs/reference/icalendar.timezone.tzp.rst new file mode 100644 index 0000000..f4f4bcb --- /dev/null +++ b/docs/reference/icalendar.timezone.tzp.rst @@ -0,0 +1,7 @@ +icalendar.timezone.tzp module +============================= + +.. automodule:: icalendar.timezone.tzp + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.timezone.windows_to_olson.rst b/docs/reference/icalendar.timezone.windows_to_olson.rst new file mode 100644 index 0000000..9e4d4ef --- /dev/null +++ b/docs/reference/icalendar.timezone.windows_to_olson.rst @@ -0,0 +1,7 @@ +icalendar.timezone.windows\_to\_olson module +============================================ + +.. automodule:: icalendar.timezone.windows_to_olson + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.timezone.zoneinfo.rst b/docs/reference/icalendar.timezone.zoneinfo.rst new file mode 100644 index 0000000..5a6e380 --- /dev/null +++ b/docs/reference/icalendar.timezone.zoneinfo.rst @@ -0,0 +1,7 @@ +icalendar.timezone.zoneinfo module +================================== + +.. automodule:: icalendar.timezone.zoneinfo + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.tools.rst b/docs/reference/icalendar.tools.rst new file mode 100644 index 0000000..5b0d130 --- /dev/null +++ b/docs/reference/icalendar.tools.rst @@ -0,0 +1,7 @@ +icalendar.tools module +====================== + +.. automodule:: icalendar.tools + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/icalendar.version.rst b/docs/reference/icalendar.version.rst new file mode 100644 index 0000000..f1c85e5 --- /dev/null +++ b/docs/reference/icalendar.version.rst @@ -0,0 +1,7 @@ +icalendar.version module +======================== + +.. automodule:: icalendar.version + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/reference/index.rst b/docs/reference/index.rst deleted file mode 100644 index c54e6c1..0000000 --- a/docs/reference/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -------------- -API Reference -------------- - -.. toctree:: - :caption: API Reference - - diff --git a/docs/reference/modules.rst b/docs/reference/modules.rst new file mode 100644 index 0000000..ac8eae9 --- /dev/null +++ b/docs/reference/modules.rst @@ -0,0 +1,7 @@ +src +=== + +.. toctree:: + :maxdepth: 4 + + icalendar