From 63c3a19fb4836930baf278dcc8b3f2dfa17fcb4f Mon Sep 17 00:00:00 2001 From: Alessandro Candido Date: Fri, 1 Mar 2024 22:49:34 +0100 Subject: [PATCH] docs: Move to standard folder naming I also like docs/ more than doc/, but it's the standard in Qibo, and this is valuable --- {docs => doc}/Makefile | 0 {docs => doc}/make.bat | 0 {docs => doc}/source/.gitignore | 0 {docs => doc}/source/_static/css/style.css | 0 {docs => doc}/source/_static/qibo_logo_dark.svg | 0 {docs => doc}/source/_static/qibo_logo_light.svg | 0 {docs => doc}/source/conf.py | 0 {docs => doc}/source/favicon.ico | Bin {docs => doc}/source/getting-started/index.rst | 0 .../source/getting-started/installation.rst | 0 {docs => doc}/source/getting-started/quickstart.rst | 0 {docs => doc}/source/index.rst | 0 docs/source/api-reference/modules.rst | 12 ------------ 13 files changed, 12 deletions(-) rename {docs => doc}/Makefile (100%) rename {docs => doc}/make.bat (100%) rename {docs => doc}/source/.gitignore (100%) rename {docs => doc}/source/_static/css/style.css (100%) rename {docs => doc}/source/_static/qibo_logo_dark.svg (100%) rename {docs => doc}/source/_static/qibo_logo_light.svg (100%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/favicon.ico (100%) rename {docs => doc}/source/getting-started/index.rst (100%) rename {docs => doc}/source/getting-started/installation.rst (100%) rename {docs => doc}/source/getting-started/quickstart.rst (100%) rename {docs => doc}/source/index.rst (100%) delete mode 100644 docs/source/api-reference/modules.rst diff --git a/docs/Makefile b/doc/Makefile similarity index 100% rename from docs/Makefile rename to doc/Makefile diff --git a/docs/make.bat b/doc/make.bat similarity index 100% rename from docs/make.bat rename to doc/make.bat diff --git a/docs/source/.gitignore b/doc/source/.gitignore similarity index 100% rename from docs/source/.gitignore rename to doc/source/.gitignore diff --git a/docs/source/_static/css/style.css b/doc/source/_static/css/style.css similarity index 100% rename from docs/source/_static/css/style.css rename to doc/source/_static/css/style.css diff --git a/docs/source/_static/qibo_logo_dark.svg b/doc/source/_static/qibo_logo_dark.svg similarity index 100% rename from docs/source/_static/qibo_logo_dark.svg rename to doc/source/_static/qibo_logo_dark.svg diff --git a/docs/source/_static/qibo_logo_light.svg b/doc/source/_static/qibo_logo_light.svg similarity index 100% rename from docs/source/_static/qibo_logo_light.svg rename to doc/source/_static/qibo_logo_light.svg diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 100% rename from docs/source/conf.py rename to doc/source/conf.py diff --git a/docs/source/favicon.ico b/doc/source/favicon.ico similarity index 100% rename from docs/source/favicon.ico rename to doc/source/favicon.ico diff --git a/docs/source/getting-started/index.rst b/doc/source/getting-started/index.rst similarity index 100% rename from docs/source/getting-started/index.rst rename to doc/source/getting-started/index.rst diff --git a/docs/source/getting-started/installation.rst b/doc/source/getting-started/installation.rst similarity index 100% rename from docs/source/getting-started/installation.rst rename to doc/source/getting-started/installation.rst diff --git a/docs/source/getting-started/quickstart.rst b/doc/source/getting-started/quickstart.rst similarity index 100% rename from docs/source/getting-started/quickstart.rst rename to doc/source/getting-started/quickstart.rst diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 100% rename from docs/source/index.rst rename to doc/source/index.rst diff --git a/docs/source/api-reference/modules.rst b/docs/source/api-reference/modules.rst deleted file mode 100644 index cf7a9af..0000000 --- a/docs/source/api-reference/modules.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _Components: - -API reference -============= - -In this section we present the main qibotn components and primitives included in the public API. - - -.. toctree:: - :maxdepth: 3 - - qibotn