This repository has been archived by the owner on Aug 19, 2023. It is now read-only.
Update makefile with autodocs, additional tweaks #70
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Misc documentation fixes: * include aqua contributors (copying the file from their repository, fixing links). * remove files not used in the build. * update images.
Move the images coming from the jupyter conversions to a single directory, at `images/figures`, for tidying up the structure (can be recreated using the `output_files_dir` parameter for nbconvert).
Update "make autodoc" by depending on three new targets, one for each project that has a different import path, allowing overriding the location via environment variables. Update aqua and chemistry .rst pointing to the autodoc modules.
Replace the `.. code:: ipython3` blocks with `.. code:: python` (can be recreated using `NbConvertBase.default_language` configuration option).
jaygambetta
approved these changes
Feb 7, 2019
jakelishman
pushed a commit
to jakelishman/qiskit-terra
that referenced
this pull request
Aug 11, 2023
…ackage#70) * Documentation fixes Misc documentation fixes: * include aqua contributors (copying the file from their repository, fixing links). * remove files not used in the build. * update images. * Move images to a single directory Move the images coming from the jupyter conversions to a single directory, at `images/figures`, for tidying up the structure (can be recreated using the `output_files_dir` parameter for nbconvert). * Update makefile to handle autodoc per project Update "make autodoc" by depending on three new targets, one for each project that has a different import path, allowing overriding the location via environment variables. Update aqua and chemistry .rst pointing to the autodoc modules. * Replace code blocks from ipython3 to python Replace the `.. code:: ipython3` blocks with `.. code:: python` (can be recreated using `NbConvertBase.default_language` configuration option). * Fix makefile phony target
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Update the
Makefilefor better supporting the generation of autodocs, allowing passing the paths for the individual components and finer-grained control of the generation.Details and comments
Performed an initial run against an environment where the packages are installed via
pip, making some tweaks accordingly:.rstand.pngfilesSome structure/warnings are included as well in this PR:
ipython3blocks withpython