Add Sphinx to autogenerate user-facing docs #114
Merged
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
|
Rebase on |
Codecov Report
@@ Coverage Diff @@
## main #114 +/- ##
=======================================
Coverage 95.33% 95.33%
=======================================
Files 35 35
Lines 1952 1952
=======================================
Hits 1861 1861
Misses 91 91 Continue to review full report at Codecov.
|
sunank200
requested review from
phanikumv,
rajaths010494,
pankajastro,
bharanidharan14 and
kaxil
kaxil
reviewed
Mar 14, 2022
kaxil
reviewed
Mar 14, 2022
| # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
| # ones. | ||
| extensions = [ | ||
| "autoapi.extension", |
There was a problem hiding this comment.
https://readthedocs.org/projects/astronomer-providers/builds/16358761/ is failing.
You should add this dependency to setup.cfg and include it in a new extra: doc and install it for readthedocs.yml
kaxil
reviewed
Mar 14, 2022
… index.rst and providers.rst
kaxil
force-pushed
the
add-docs
branch
2 times, most recently
from
c3e68c3 to
4a08427
Compare
kaxil
approved these changes
Mar 15, 2022
|
I made some changes via the following commits @sunank200 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Use Sphinx and Sphinx auto-api extension to autogenerate docs to achieve the following:
closes: #64