From c3dc20395d659dd6d11c957179c49319b4b7753a Mon Sep 17 00:00:00 2001 From: Hiroya-W Date: Mon, 14 Mar 2022 16:32:09 +0900 Subject: [PATCH] =?UTF-8?q?Revert=20"Sphinx=E3=83=89=E3=82=AD=E3=83=A5?= =?UTF-8?q?=E3=83=A1=E3=83=B3=E3=83=88=E3=81=AE=E3=83=95=E3=82=A9=E3=83=AB?= =?UTF-8?q?=E3=83=80=E3=82=92=20docs=20=E3=81=8B=E3=82=89=20doc=20?= =?UTF-8?q?=E3=81=AB=E7=A7=BB=E5=8B=95=E3=81=99=E3=82=8B"?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/doc.yml | 1 + CONTRIBUTING-en.md | 3 ++- CONTRIBUTING-ja.md | 3 ++- {doc => docs}/Makefile | 0 {doc => docs}/make.bat | 0 {doc => docs}/source/_static/simple_circuit1.png | Bin {doc => docs}/source/conf.py | 0 {doc => docs}/source/contents.rst | 0 {doc => docs}/source/index.rst | 0 {doc => docs}/source/options.rst | 0 10 files changed, 5 insertions(+), 2 deletions(-) rename {doc => docs}/Makefile (100%) rename {doc => docs}/make.bat (100%) rename {doc => docs}/source/_static/simple_circuit1.png (100%) rename {doc => docs}/source/conf.py (100%) rename {doc => docs}/source/contents.rst (100%) rename {doc => docs}/source/index.rst (100%) rename {doc => docs}/source/options.rst (100%) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 992e0f1..ea44e41 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -41,6 +41,7 @@ jobs: - name: Build documentation run: | make html + working-directory: ./docs - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3.7.3 diff --git a/CONTRIBUTING-en.md b/CONTRIBUTING-en.md index 487b6db..2f9e04c 100644 --- a/CONTRIBUTING-en.md +++ b/CONTRIBUTING-en.md @@ -137,9 +137,10 @@ The documentation is built and deployed on pushing(merged from PR) to `main` bra ### Build document -Run following command. +Move to the `docs` folder and run the command to generate the documentation. ```bash +cd docs make html ``` diff --git a/CONTRIBUTING-ja.md b/CONTRIBUTING-ja.md index 3cce5d0..f5990c1 100644 --- a/CONTRIBUTING-ja.md +++ b/CONTRIBUTING-ja.md @@ -137,9 +137,10 @@ pip install git+https://github.com/Qulacs-Osaka/qulacs-visualizer ### Build document -以下のコマンドを実行します。 +`docs` フォルダに移動し、コマンドを実行することで、ドキュメントを生成することが出来ます。 ```bash +cd docs make html ``` diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat diff --git a/doc/source/_static/simple_circuit1.png b/docs/source/_static/simple_circuit1.png similarity index 100% rename from doc/source/_static/simple_circuit1.png rename to docs/source/_static/simple_circuit1.png diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 100% rename from doc/source/conf.py rename to docs/source/conf.py diff --git a/doc/source/contents.rst b/docs/source/contents.rst similarity index 100% rename from doc/source/contents.rst rename to docs/source/contents.rst diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to docs/source/index.rst diff --git a/doc/source/options.rst b/docs/source/options.rst similarity index 100% rename from doc/source/options.rst rename to docs/source/options.rst