From db22505d0a8f6f958e2e9f60564000ded11a58aa Mon Sep 17 00:00:00 2001 From: Sina Atalay Date: Sun, 26 Nov 2023 16:40:43 +0100 Subject: [PATCH] rename Code Documentation to API Reference --- README.md | 2 +- docs/{documentation => api_reference}/__main__.md | 0 docs/{documentation => api_reference}/data_model.md | 0 docs/{documentation => api_reference}/index.md | 0 docs/{documentation => api_reference}/rendering.md | 0 mkdocs.yaml | 10 +++++----- 6 files changed, 6 insertions(+), 6 deletions(-) rename docs/{documentation => api_reference}/__main__.md (100%) rename docs/{documentation => api_reference}/data_model.md (100%) rename docs/{documentation => api_reference}/index.md (100%) rename docs/{documentation => api_reference}/rendering.md (100%) diff --git a/README.md b/README.md index f64e1c0..769b972 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ cv: A more detailed user guide can be found [here](https://sinaatalay.github.io/rendercv/user_guide). -I documented the whole code with docstrings and used comments throughout the code. The code documentation can be found [here](https://sinaatalay.github.io/rendercv/documentation/). +I documented the whole code with docstrings and used comments throughout the code. The API reference can be found [here](https://sinaatalay.github.io/rendercv/api_reference/). ## Contributing diff --git a/docs/documentation/__main__.md b/docs/api_reference/__main__.md similarity index 100% rename from docs/documentation/__main__.md rename to docs/api_reference/__main__.md diff --git a/docs/documentation/data_model.md b/docs/api_reference/data_model.md similarity index 100% rename from docs/documentation/data_model.md rename to docs/api_reference/data_model.md diff --git a/docs/documentation/index.md b/docs/api_reference/index.md similarity index 100% rename from docs/documentation/index.md rename to docs/api_reference/index.md diff --git a/docs/documentation/rendering.md b/docs/api_reference/rendering.md similarity index 100% rename from docs/documentation/rendering.md rename to docs/api_reference/rendering.md diff --git a/mkdocs.yaml b/mkdocs.yaml index 93ac025..ef1d423 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -46,11 +46,11 @@ theme: nav: - Overview: index.md - User Guide: user_guide.md - - Code Documentation: - - Code Documentation: documentation/index.md - - __main__.py: documentation/__main__.md - - data_model.py: documentation/data_model.md - - rendering.py: documentation/rendering.md + - API Reference: + - API Reference: api_reference/index.md + - __main__.py: api_reference/__main__.md + - data_model.py: api_reference/data_model.md + - rendering.py: api_reference/rendering.md markdown_extensions: # see https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/ for more pymdownx info