Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Sphinx documentation #184

Merged
merged 2 commits into from
Jun 20, 2023
Merged

Added Sphinx documentation #184

merged 2 commits into from
Jun 20, 2023

Conversation

nfx
Copy link
Contributor

@nfx nfx commented Jun 19, 2023

  • Service-focused, not class-focused
  • Omits detailed class documentation for now
  • Integrates cross-compiled usage examples

Usage:

  • install SDK in the current virtual env
  • make gen to regenerate *.rst files
  • make clean livehtml to preview in browser
image

- Service-focused, not class-focused
- Omits detailed class documentation for now
- Integrates cross-compiled usage examples

Usage:

- install SDK in the current virtual env
- `make gen` to regenerate `*.rst` files
- `make clean livehtml` to preview in browser
@nfx nfx requested a review from a team June 19, 2023 13:54
@nfx nfx merged commit 2cfa289 into main Jun 20, 2023
@nfx nfx deleted the sphinx-docs-v2 branch June 20, 2023 18:17
@nfx nfx mentioned this pull request Jun 21, 2023
nfx added a commit that referenced this pull request Jun 21, 2023
* Added Sphinx documentation
([#184](#184),
[#191](#191),
[#183](#183),
[#193](#193)).
* Integrated with ReadTheDocs service
([#188](#188),
[#189](#189),
[#190](#190)).
* Create a deepcopy of config in api client
([#172](#172)).
* Fix client/secret auth
([#186](#186)).
* Increase DBFS copy buffer size
([#185](#185)).
* Move classes to other repository
([#192](#192)).
* Relax `requests` version upper bound to <3
([#138](#138)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant