From e56d2a738e1b942c084b61ead01537217bbd4e4e Mon Sep 17 00:00:00 2001 From: = Date: Fri, 8 Sep 2023 11:14:46 +0800 Subject: [PATCH] Misc fixes for doc --- {docs => doc}/Makefile | 0 {docs => doc}/make.bat | 0 doc/source/_static/css/style.css | 7 + doc/source/_static/qibo_logo_dark.svg | 121 ++++++++++++++++++ doc/source/_static/qibo_logo_light.svg | 80 ++++++++++++ {docs => doc}/source/api-reference/ansatz.rst | 0 {docs => doc}/source/api-reference/driver.rst | 0 {docs => doc}/source/api-reference/index.rst | 0 .../source/api-reference/measurement.rst | 0 {docs => doc}/source/conf.py | 2 + .../source/developer-guides/index.rst | 0 .../source/getting-started/ansatz.rst | 0 .../source/getting-started/hamiltonian.rst | 0 .../source/getting-started/index.rst | 0 .../source/getting-started/installation.rst | 0 .../source/getting-started/measurement.rst | 0 .../source/getting-started/molecule.rst | 0 ...qibochem_doc_ansatz_hardware-efficient.svg | 0 {docs => doc}/source/index.rst | 0 19 files changed, 210 insertions(+) rename {docs => doc}/Makefile (100%) rename {docs => doc}/make.bat (100%) create mode 100644 doc/source/_static/css/style.css create mode 100644 doc/source/_static/qibo_logo_dark.svg create mode 100644 doc/source/_static/qibo_logo_light.svg rename {docs => doc}/source/api-reference/ansatz.rst (100%) rename {docs => doc}/source/api-reference/driver.rst (100%) rename {docs => doc}/source/api-reference/index.rst (100%) rename {docs => doc}/source/api-reference/measurement.rst (100%) rename {docs => doc}/source/conf.py (96%) rename {docs => doc}/source/developer-guides/index.rst (100%) rename {docs => doc}/source/getting-started/ansatz.rst (100%) rename {docs => doc}/source/getting-started/hamiltonian.rst (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/measurement.rst (100%) rename {docs => doc}/source/getting-started/molecule.rst (100%) rename {docs => doc}/source/getting-started/qibochem_doc_ansatz_hardware-efficient.svg (100%) rename {docs => doc}/source/index.rst (100%) 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/doc/source/_static/css/style.css b/doc/source/_static/css/style.css new file mode 100644 index 0000000..46c934c --- /dev/null +++ b/doc/source/_static/css/style.css @@ -0,0 +1,7 @@ +.wy-side-nav-search { + background-color: #6400FF; +} + +.wy-nav-top { + background-color: #6400FF; +} diff --git a/doc/source/_static/qibo_logo_dark.svg b/doc/source/_static/qibo_logo_dark.svg new file mode 100644 index 0000000..3b7dc40 --- /dev/null +++ b/doc/source/_static/qibo_logo_dark.svg @@ -0,0 +1,121 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + diff --git a/doc/source/_static/qibo_logo_light.svg b/doc/source/_static/qibo_logo_light.svg new file mode 100644 index 0000000..bb907e7 --- /dev/null +++ b/doc/source/_static/qibo_logo_light.svg @@ -0,0 +1,80 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + diff --git a/docs/source/api-reference/ansatz.rst b/doc/source/api-reference/ansatz.rst similarity index 100% rename from docs/source/api-reference/ansatz.rst rename to doc/source/api-reference/ansatz.rst diff --git a/docs/source/api-reference/driver.rst b/doc/source/api-reference/driver.rst similarity index 100% rename from docs/source/api-reference/driver.rst rename to doc/source/api-reference/driver.rst diff --git a/docs/source/api-reference/index.rst b/doc/source/api-reference/index.rst similarity index 100% rename from docs/source/api-reference/index.rst rename to doc/source/api-reference/index.rst diff --git a/docs/source/api-reference/measurement.rst b/doc/source/api-reference/measurement.rst similarity index 100% rename from docs/source/api-reference/measurement.rst rename to doc/source/api-reference/measurement.rst diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 96% rename from docs/source/conf.py rename to doc/source/conf.py index 6f078a5..fb3c486 100644 --- a/docs/source/conf.py +++ b/doc/source/conf.py @@ -16,6 +16,8 @@ extensions = [ "sphinx.ext.autodoc", + "sphinx.ext.doctest", + "sphinx.ext.coverage", "sphinxcontrib.katex", ] diff --git a/docs/source/developer-guides/index.rst b/doc/source/developer-guides/index.rst similarity index 100% rename from docs/source/developer-guides/index.rst rename to doc/source/developer-guides/index.rst diff --git a/docs/source/getting-started/ansatz.rst b/doc/source/getting-started/ansatz.rst similarity index 100% rename from docs/source/getting-started/ansatz.rst rename to doc/source/getting-started/ansatz.rst diff --git a/docs/source/getting-started/hamiltonian.rst b/doc/source/getting-started/hamiltonian.rst similarity index 100% rename from docs/source/getting-started/hamiltonian.rst rename to doc/source/getting-started/hamiltonian.rst 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/measurement.rst b/doc/source/getting-started/measurement.rst similarity index 100% rename from docs/source/getting-started/measurement.rst rename to doc/source/getting-started/measurement.rst diff --git a/docs/source/getting-started/molecule.rst b/doc/source/getting-started/molecule.rst similarity index 100% rename from docs/source/getting-started/molecule.rst rename to doc/source/getting-started/molecule.rst diff --git a/docs/source/getting-started/qibochem_doc_ansatz_hardware-efficient.svg b/doc/source/getting-started/qibochem_doc_ansatz_hardware-efficient.svg similarity index 100% rename from docs/source/getting-started/qibochem_doc_ansatz_hardware-efficient.svg rename to doc/source/getting-started/qibochem_doc_ansatz_hardware-efficient.svg 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