feat: improve contribute section documentation #2085
+781
−56
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2085 +/- ##
==========================================
+ Coverage 86.24% 86.65% +0.40%
==========================================
Files 90 90
Lines 10274 10274
==========================================
+ Hits 8861 8903 +42
+ Misses 1413 1371 -42 |
|
Moving to ready for review to check generated documentation |
PProfizi
added
documentation
| BUILD_API = True if os.environ.get("BUILD_API", "true") == "true" else False | ||
| if not BUILD_API: | ||
| extensions.remove("ansys_sphinx_theme.extension.autoapi") |
There was a problem hiding this comment.
Suggested change
| extensions.remove("ansys_sphinx_theme.extension.autoapi") | |
| extensions.extend("ansys_sphinx_theme.extension.autoapi") |
Add the extension only if there is env variable, remove it from extensions
| # Optionally exclude api or example documentation generation. | ||
| BUILD_API = True if os.environ.get("BUILD_API", "true") == "true" else False | ||
| if not BUILD_API: |
There was a problem hiding this comment.
Suggested change
| if not BUILD_API: | |
| if BUILD_API: |
Comment on lines
+407
to
+409
| if not BUILD_EXAMPLES: | ||
| extensions.remove("sphinx_gallery.gen_gallery") |
There was a problem hiding this comment.
Suggested change
| BUILD_EXAMPLES = True if os.environ.get("BUILD_EXAMPLES", "true") == "true" else False | |
| if not BUILD_EXAMPLES: | |
| extensions.remove("sphinx_gallery.gen_gallery") | |
| BUILD_EXAMPLES = True if os.environ.get("BUILD_EXAMPLES", "true") == "true" else False | |
| if BUILD_EXAMPLES: | |
| extensions.extend("sphinx_gallery.gen_gallery") |
same here
| @@ -109,6 +111,7 @@ | |||
| "sphinx.ext.todo", | |||
| "sphinx_copybutton", | |||
| "sphinx_design", | |||
| "sphinx_jinja", | |||
| "sphinx_gallery.gen_gallery", | |||
| 'sphinx_reredirects', | |||
| "ansys_sphinx_theme.extension.autoapi", | |||
There was a problem hiding this comment.
Suggested change
| "ansys_sphinx_theme.extension.autoapi", |
| @@ -109,6 +111,7 @@ | |||
| "sphinx.ext.todo", | |||
| "sphinx_copybutton", | |||
| "sphinx_design", | |||
| "sphinx_jinja", | |||
| "sphinx_gallery.gen_gallery", | |||
There was a problem hiding this comment.
Suggested change
| "sphinx_gallery.gen_gallery", |
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.
Summary
As stated in the title
Details
The following have been done: