Skip to content

docs: add documentation#66

Merged
dpcollins-google merged 15 commits into
masterfrom
documentation
Nov 19, 2020
Merged

docs: add documentation#66
dpcollins-google merged 15 commits into
masterfrom
documentation

Conversation

@anguillanneuf
Copy link
Copy Markdown
Contributor

Fixes #44 One step closer to releasing the library!

This PR

  • Exposes handwritten classes in documentation
  • Adds pages for admin, publisher, subscriber clients

Question?

  • Shall we publish members of google.cloud.pubsublite_v1.services and google.cloud.pubsublite_v1.types if we don't expect people to use them? I can selectively publish some but not others.
# Open generated docs in /docs/_build/html/index.html in a browser
pip install -e .
pip install sphinx alabaster recommonmark
sphinx-build -W -T -N -b html -d docs/_build/doctrees/ docs/ docs/_build/html/

# Alternatively,
nox -s docs

@anguillanneuf anguillanneuf requested a review from a team November 14, 2020 01:34
@google-cla google-cla Bot added the cla: yes This human has signed the Contributor License Agreement. label Nov 14, 2020
@product-auto-label product-auto-label Bot added the api: pubsublite Issues related to the googleapis/python-pubsublite API. label Nov 14, 2020
Copy link
Copy Markdown
Contributor

@dpcollins-google dpcollins-google left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved once comments are resolved

Comment thread docs/subscriber/index.rst
Comment thread docs/subscriber/index.rst
Comment thread docs/admin/index.rst Outdated
Comment thread docs/publisher/index.rst
Comment thread docs/subscriber/index.rst Outdated
Comment thread docs/subscriber/index.rst Outdated
@anguillanneuf anguillanneuf added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 18, 2020
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 18, 2020
@dpcollins-google dpcollins-google merged commit fda26bc into master Nov 19, 2020
@anguillanneuf anguillanneuf deleted the documentation branch November 19, 2020 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: pubsublite Issues related to the googleapis/python-pubsublite API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: expose handwritten layer in documentation

3 participants