Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

Update makefile with autodocs, additional tweaks #70

Merged
merged 7 commits into from
Feb 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,36 @@
# This source code is licensed under the Apache License, Version 2.0 found in
# the LICENSE.txt file in the root directory of this source tree.

.PHONY: doc autodoc clean
.PHONY: doc autodoc autodoc_qiskit autodoc_aqua autodoc_chemistry clean

SITE_PACKAGES := $(shell pip show qiskit | grep Location | sed 's/Location: //')
# Define the paths where the different packages are placed. If present in an
# environment variable with the same name (ie. "PATH_QISKIT=/a/b/c make doc"),
# the environment variable value will take precedence.
PATH_QISKIT ?= $(shell pip show qiskit-terra | grep Location | sed 's/Location: //')
PATH_AQUA ?= $(shell pip show qiskit-aqua | grep Location | sed 's/Location: //')
PATH_CHEMISTRY ?= $(shell pip show qiskit-chemistry | grep Location | sed 's/Location: //')

autodoc:
ifneq ($(SITE_PACKAGES), )
autodoc_qiskit:
ifneq ($(PATH_QISKIT), )
sphinx-apidoc --output docs/autodoc --separate --implicit-namespaces --module-first -d 16 \
$(SITE_PACKAGES)/qiskit
$(PATH_QISKIT)/qiskit
endif

autodoc_aqua:
ifneq ($(PATH_AQUA), )
sphinx-apidoc --output docs/autodoc --separate --implicit-namespaces --module-first -d 16 \
$(PATH_QISKIT)/qiskit_aqua
endif

autodoc_chemistry:
ifneq ($(PATH_CHEMISTRY), )
sphinx-apidoc --output docs/autodoc --separate --implicit-namespaces --module-first -d 16 \
$(PATH_CHEMISTRY)/qiskit_chemistry
endif

autodoc: autodoc_qiskit autodoc_aqua autodoc_chemistry
ifneq ($(PATH_TERRA) $(PATH_AQUA) $(PATH_CHEMISTRY), )
rm -f docs/autodoc/modules.rst
endif

doc: autodoc
Expand Down
36 changes: 36 additions & 0 deletions docs/aqua/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
------------------------------------
Contributors (in Alphabetical Order)
------------------------------------

Aqua was inspired, authored and brought about by the collective
work of a team of researchers.
Aqua continues now to grow with the help and work of many
people, listed here in alphabetical order, who contribute to the project at different
levels:

- `Panagiotis Barkoutsos <https://researcher.watson.ibm.com/researcher/view.php?person=zurich-BPA>`__
- Sergey Bravyi
- Chun-Fu (Richard) Chen
- `Antonio Córcoles-Gonzalez <https://researcher.watson.ibm.com/researcher/view.php?person=us-adcorcol>`__
- Albert Frisch
- `Jay Gambetta <https://researcher.watson.ibm.com/researcher/view.php?person=us-jay.gambetta>`__
- Jennifer Glick
- `Donny Greenberg <https://researcher.watson.ibm.com/researcher/view.php?person=ibm-donny>`__
- Tanvi Gujarati
- `Shaohan Hu <https://researcher.watson.ibm.com/researcher/view.php?person=ibm-Shaohan.Hu>`__
- `Takashi Imamichi <https://researcher.watson.ibm.com/researcher/view.php?person=jp-IMAMICHI>`__
- Tal Kachman
- `Peng Liu <https://researcher.watson.ibm.com/researcher/view.php?person=us-liup>`__
- Manoel Marques
- Antonio Mezzacapo
- `Nikolaj Moll <https://researcher.watson.ibm.com/researcher/view.php?person=zurich-NIM>`__
- `Giacomo Nannicini <https://researcher.watson.ibm.com/researcher/view.php?person=us-nannicini>`__
- Pauline Ollitrault
- `Anna Phan <https://researcher.watson.ibm.com/researcher/view.php?person=au1-anna.phan>`__
- `Marco Pistoia <https://researcher.watson.ibm.com/researcher/view.php?person=us-pistoia>`__
- `Julia Rice <https://researcher.watson.ibm.com/researcher/view.php?person=us-jrice>`__
- `Raymond Harry Putra Rudy <https://researcher.watson.ibm.com/researcher/view.php?person=jp-RUDYHAR>`__
- `Kanav Setia <https://physics.dartmouth.edu/people/kanav-setia>`__
- `Ivano Tavernelli <https://researcher.watson.ibm.com/researcher/view.php?person=zurich-ITA>`__
- `Stephen Wood <https://researcher.watson.ibm.com/researcher/view.php?person=us-woodsp>`__
- `Stefan Woerner <https://researcher.watson.ibm.com/researcher/view.php?person=zurich-wor>`__
1 change: 1 addition & 0 deletions docs/aqua/aqua.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ and then the domain-specific applications of Aqua: Chemistry, AI and Optimizatio
Qiskit Optimization <optimization/qiskit_optimization>
Qiskit Finance <finance/qiskit_finance>
Aqua Tutorials <tutorials/aqua_tutorials>
Release history <release_history>
42 changes: 0 additions & 42 deletions docs/aqua/chemistry/index.rst

This file was deleted.

3 changes: 2 additions & 1 deletion docs/aqua/chemistry/qiskit_chemistry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,5 @@ real quantum device).
Translators <qiskit_chemistry_translators>
Configuring and Running an Experiment <qiskit_chemistry_execution>
Contributing to Qiskit Chemistry <qiskit_chemistry_extending>
Qiskit Chemistry SDK Reference <qiskit_chemistry_sdk>
Qiskit Chemistry SDK Reference <../../autodoc/qiskit_chemistry>
Release history <release_history>
21 changes: 0 additions & 21 deletions docs/aqua/index.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/aqua/library.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ real quantum device).
Multiclass Extensions <multiclass_extensions>
Random Distributions <random_distributions>
Uncertainty Problems <uncertainty_problems>
Aqua SDK Reference <qiskit_aqua>
Aqua SDK Reference <../autodoc/qiskit_aqua>
2 changes: 1 addition & 1 deletion docs/aqua/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ correctness is dynamically enforced even for components that are
dynamically discovered and loaded.


.. include:: ../CONTRIBUTORS.RST
.. include:: CONTRIBUTORS.rst

-------
License
Expand Down
Loading