add qiskit-classroom api documents

KMU-quantum-classroom · Sep 6, 2023 · 44a7974 · 44a7974
1 parent 1f191a8
commit 44a7974
Show file tree

Hide file tree

Showing 15 changed files with 10,593 additions and 2 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./qiskit_classroom.html"/>
+</head>
+</html>
diff --git a/docs/qiskit_classroom.html b/docs/qiskit_classroom.html
diff --git a/docs/qiskit_classroom/converter_model.html b/docs/qiskit_classroom/converter_model.html
diff --git a/docs/qiskit_classroom/converter_presenter.html b/docs/qiskit_classroom/converter_presenter.html
diff --git a/docs/qiskit_classroom/converter_view.html b/docs/qiskit_classroom/converter_view.html
diff --git a/docs/qiskit_classroom/expression_enum.html b/docs/qiskit_classroom/expression_enum.html
diff --git a/docs/qiskit_classroom/input_model.html b/docs/qiskit_classroom/input_model.html
diff --git a/docs/qiskit_classroom/input_view.html b/docs/qiskit_classroom/input_view.html
diff --git a/docs/qiskit_classroom/result_image_dialog.html b/docs/qiskit_classroom/result_image_dialog.html
diff --git a/docs/qiskit_classroom/worker.html b/docs/qiskit_classroom/worker.html
diff --git a/docs/search.js b/docs/search.js
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,7 +32,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-dev = ["coverage==7.3.0", "pylint==2.17.5", "tox==4.10.0", "build==0.10.0"]
+dev = ["coverage==7.3.0", "pylint==2.17.5", "tox==4.10.0", "build==0.10.0", "pdoc==14.0.0"]
 
 [project.urls]
 "Homepage" = "https://github.com/KMU-quantum-classroom/qiskit-classroom-converter"

diff --git a/qiskit_classroom/__init__.py b/qiskit_classroom/__init__.py
@@ -1,4 +1,72 @@
-"""init python script for this pacakge"""
+"""
+# Qiskit-Classroom
+
+Qiskit-classroom is a toolkit that helps implement quantum algorithms by converting and visualizing different
+expressions used in the Qiskit ecosystem using Qiskit-classroom-converter.
+The following three transformations are supported.
+
+* Quantum Circuit to Dirac notation
+
+* Quantum Circuit to Matrix
+
+* Matrix to Quantum Circuit
+
+## Getting Started
+
+### Prerequisites
+
+* LaTeX distribution(or program) must be installed
+
+  * On GNU/Linux recommend TeX Live
+
+  * On Windows recommend MiKTeX
+
+* git should be installed
+
+* python must be installed (3.9 <= X <= 3.11)
+
+* Qt6(>= 6.0.x) must be installed
+    * macOS : https://pyside.readthedocs.io/en/latest/installing/macosx.html
+
+### Install with Flatpak (GNU/Linux)
+
+We're currently packaging flatpak package. please wait for a couple of days
+
+### Install with PyPi (Windows, macOS)
+
+```
+pip install qiskit-classroom
+```
+
+.. warning:: Apple Silicon
+    ARM Processor not supported read this article
+
+you must install latex distribution(program).
+
+## How to debug
+
+```bash
+# download package
+git https://github.com/KMU-quantum-classrooom/qiksit-classroom.git
+
+# install python packages
+cd qiskit-classroom
+pip install -r requirements.txt
+
+# run scripts
+python -m main.py
+```
+
+## Acknowledgement
+
+* 국문 : "본 연구는 2022년 과학기술정보통신부 및 정보통신기획평가원의 SW중심대학사업의 연구결과로 수행되었음"(2022-0-00964)
+
+* English : "This research was supported by the MIST(Ministry of Science, ICT), Korea, under the National Program for Excellence in SW), supervised by the IITP(Institute of Information & communications Technology Planning & Evaluation) in 2022"(2022-0-00964)
+
+## License
+
+Qiskit-Classroom is licensed under the Apache License, Version 2.0
+"""
 
 #  Licensed to the Apache Software Foundation (ASF) under one
 #  or more contributor license agreements.  See the NOTICE file

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -2,3 +2,4 @@ coverage==7.3.0
 pylint==2.17.5
 tox==4.10.0
 build==0.10.0
+pdoc==14.0.0
diff --git a/scripts/generate_documents.sh b/scripts/generate_documents.sh
@@ -0,0 +1 @@
+pdoc ./qiskit_classroom -o ./docs