From fb8c65155832aa1550ebfd2260a4b65c88ec986d Mon Sep 17 00:00:00 2001 From: James B Date: Fri, 4 Oct 2024 09:37:08 +0100 Subject: [PATCH] docs content --- docs/conf.py | 4 ++++ docs/index.rst | 8 ++++++++ docs/migration-from-lib-cove.rst | 13 +++++++++++++ docs/python-api/index.rst | 9 +++++++++ docs/python-api/org-ids.rst | 7 +++++++ docs/used-by.rst | 10 ++++++++++ 6 files changed, 51 insertions(+) create mode 100644 docs/migration-from-lib-cove.rst create mode 100644 docs/python-api/index.rst create mode 100644 docs/python-api/org-ids.rst create mode 100644 docs/used-by.rst diff --git a/docs/conf.py b/docs/conf.py index 43ec2e2..bdd8cc6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,3 +3,7 @@ master_doc = "index" html_theme = "odsc_default_sphinx_theme" + +extensions = [ + "sphinx.ext.autodoc", +] diff --git a/docs/index.rst b/docs/index.rst index ab3c053..3942d47 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,11 @@ LibCove2 ======== + +.. toctree:: + :maxdepth: 2 + + python-api/index.rst + migration-from-lib-cove.rst + used-by.rst + diff --git a/docs/migration-from-lib-cove.rst b/docs/migration-from-lib-cove.rst new file mode 100644 index 0000000..df89270 --- /dev/null +++ b/docs/migration-from-lib-cove.rst @@ -0,0 +1,13 @@ +Migration from lib-cove +======================= + + +This library is an updated version of the previous library ( https://github.com/OpenDataServices/lib-cove ). + +However, the structure of the library and how it works have massive changes. +For this reason the upgrade path isn't a simple upgrade, but requires rewriting work in the software that uses this. + +This is why this library is a separate git repository and a separate pypi package, +so that development of the previous library can also continue and users are not forced to upgrade before they are ready. + + diff --git a/docs/python-api/index.rst b/docs/python-api/index.rst new file mode 100644 index 0000000..dfacd2d --- /dev/null +++ b/docs/python-api/index.rst @@ -0,0 +1,9 @@ +Python API +========== + + +.. toctree:: + :maxdepth: 2 + + org-ids.rst + diff --git a/docs/python-api/org-ids.rst b/docs/python-api/org-ids.rst new file mode 100644 index 0000000..275dfbf --- /dev/null +++ b/docs/python-api/org-ids.rst @@ -0,0 +1,7 @@ +Org-IDs +======= + +.. autofunction:: libcove2.common.get_orgids_prefixes + + + diff --git a/docs/used-by.rst b/docs/used-by.rst new file mode 100644 index 0000000..c593741 --- /dev/null +++ b/docs/used-by.rst @@ -0,0 +1,10 @@ +Used by +======= + +This library is used by: + +* https://github.com/openownership/lib-cove-bods +* https://github.com/Open-Telecoms-Data/lib-cove-ofds +* https://github.com/GFDRR/rdls-lib-cove + +