[APIC-76] include services and other missing resources in sphinx docs #406
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
… `json_values`, `services`, and `storage_hosts` so that they show up in the sphinx docs
mheilman
force-pushed
the
include_resources_in_docs
branch
from
0fc55e3
to
53870e6
Compare
byndcivilization
added a commit
that referenced
this pull request
Sep 10, 2020
…city * master: [APIC-314] Refactored File Cleaning Logic (#405) [APIC-307] fix a workflows usage example in docs/source/client.rst (#409) add some missing PR numbers to the changelog (#408) Update the API spec at `civis/tests/civis_api_spec.json` so that new endpoints are included (e.g., `/exports/files/csv`) (#407) Updated list of base API resources to include `aliases`, `git_repos`, `json_values`, `services`, and `storage_hosts` so that they show up in the sphinx docs (#406) [APIC-284] remove python 3.5 support since it is reaching EOL (#404) [APIC-305] Require sql_type for every column when table_columns is provided (CHANGELOG) (#403) [APIC-313] retain specific sql types in civis_file_to_table (#402)
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.
This adds some missing API resources to the list of resources that the sphinx doc generation code uses to create https://civis-python.readthedocs.io/en/stable/api_resources.html. Using the list to filter the resources is a way to avoid including, e.g., "admin" endpoints that users aren't going to be interested in. Maybe we should eventually just include all the resources in the doc, but I didn't want to make that larger change at the moment.