Move API docs to apidoc folder (Qiskit#599)

This mirrors how we do API docs in Qiskit, Runtime, and Provider. It's necessary to use this repository as an integration test for qiskit/documentation.
arnaucasau · Mar 5, 2024 · 9bfd686 · 9bfd686
1 parent 418231e
commit 9bfd686
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/...docs/docs/sphinx_guide/inline_classes.rst → example_docs/docs/apidoc/inline_classes.rst b/...docs/docs/sphinx_guide/inline_classes.rst → example_docs/docs/apidoc/inline_classes.rst
diff --git a/example_docs/docs/sphinx_guide/autodoc.rst → example_docs/docs/apidoc/module.rst b/example_docs/docs/sphinx_guide/autodoc.rst → example_docs/docs/apidoc/module.rst
diff --git a/example_docs/docs/index.rst b/example_docs/docs/index.rst
@@ -19,8 +19,8 @@ A site to test out styling for qiskit-sphinx-theme.
   :caption: API
   :maxdepth: 2
 
-   Autodoc <sphinx_guide/autodoc>
-   Inline classes <sphinx_guide/inline_classes>
+   Autodoc <apidoc/module>
+   Inline classes <apidoc/inline_classes>
 
 .. toctree::
    :caption: Special elements

diff --git a/tests/js/tests.js b/tests/js/tests.js
@@ -45,7 +45,7 @@ test("right side bar is not broken by our page layout", async ({ page }) => {
 test.describe("left side bar", () => {
   test("renders correctly", async ({ page }) => {
     // Go to a top-level page so that we can see how the expanded side bar looks.
-    await page.goto("sphinx_guide/autodoc.html");
+    await page.goto("apidoc/module.html");
     const leftToC = page.locator(".sidebar-drawer");
     await expect(leftToC).toHaveScreenshot();
   });
@@ -69,7 +69,7 @@ test.describe("left side bar", () => {
 
 test.describe("api docs", () => {
   test("module page", async ({ page }) => {
-    await page.goto("sphinx_guide/autodoc.html");
+    await page.goto("apidoc/module.html");
     const content = page.locator("div.article-container");
     await expect(content).toHaveScreenshot();
   });
@@ -87,7 +87,7 @@ test.describe("api docs", () => {
   });
 
   test("inline classes", async ({ page }) => {
-    await page.goto("sphinx_guide/inline_classes.html");
+    await page.goto("apidoc/inline_classes.html");
     const content = page.locator("div.article-container");
     await expect(content).toHaveScreenshot();
   });