From 618cc8d0dd5c93656b32016f0a40c423be5c386c Mon Sep 17 00:00:00 2001 From: Frode Helgetun Krogh <70878501+frodehk@users.noreply.github.com> Date: Wed, 11 Dec 2024 09:36:24 +0100 Subject: [PATCH] docs: remove api reference --- docs/docs/about/getting_started/api/index.md | 2 +- docs/make-api-reference.py | 25 -------------------- 2 files changed, 1 insertion(+), 26 deletions(-) delete mode 100644 docs/make-api-reference.py diff --git a/docs/docs/about/getting_started/api/index.md b/docs/docs/about/getting_started/api/index.md index caef8e958a..79ca657622 100644 --- a/docs/docs/about/getting_started/api/index.md +++ b/docs/docs/about/getting_started/api/index.md @@ -4,4 +4,4 @@ sidebar_position: 3 --- # API Reference -Generated API reference for the libecalc library can be found [here](https://equinor.github.io/ecalc/docs/about/references/api/libecalc.html). +API reference for the libecalc library will be available here later in 2025. diff --git a/docs/make-api-reference.py b/docs/make-api-reference.py deleted file mode 100644 index 81e23b5b35..0000000000 --- a/docs/make-api-reference.py +++ /dev/null @@ -1,25 +0,0 @@ -import shutil -from pathlib import Path - -from pdoc import pdoc - - -if __name__ == "__main__": - """ - Autogenerate python API documentation - - Output will be put in the docusaurus build directory - """ - here = Path(__file__).parent - out = here / "temp_api_docs" - destination = here / "build" / "docs" / "about" / "getting_started" / "api" - if out.exists(): - shutil.rmtree(out) - - # Generate reference documentation using pdoc - modules = ["libecalc", "!libecalc.application", "!libecalc.core", "!libecalc.fixtures", "!libecalc.presentation"] - pdoc(*modules, output_directory=out) - - shutil.move(str(out / "libecalc.html"), str(destination)) - shutil.move(str(out / "libecalc"), str(destination)) - shutil.rmtree(out)