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

Add a 'docs-doc2dash' Tox target. #1702

Merged
merged 2 commits into from
Sep 26, 2016
Merged

Add a 'docs-doc2dash' Tox target. #1702

merged 2 commits into from
Sep 26, 2016

Conversation

tseaver
Copy link
Contributor

@tseaver tseaver commented Apr 7, 2016

Generates a Dash-style docset from the Sphinx-rendered HTML using doc2dash.

I've copied the docset manually into my Zeal library, and it looks pretty good.

Follow-up to my comment on #1690.

@tseaver tseaver added the docs label Apr 7, 2016
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Apr 7, 2016
@dhermes
Copy link
Contributor

dhermes commented Apr 7, 2016

Do we actually need this?

@jgeewax
Copy link
Contributor

jgeewax commented Apr 7, 2016

Yea - confused. What's the goal ?

@tseaver
Copy link
Contributor Author

tseaver commented Apr 7, 2016

The goal is to generate Dash-compatible docsets, to allow developers to import the docs into their offline API docs (searchable/readable via Dash, Zeal, etc.): I was trying to address one of the problems with just expecting people to read the online docs.

@daspecster
Copy link
Contributor

I know a decent number of people that use Dash. If this works as is and is low maintenance, I vote to use it.

@dhermes
Copy link
Contributor

dhermes commented Sep 23, 2016

@tseaver Shall we close this PR?

Generates a Dash-style docset from the Sphinx-rendered HTML.
@tseaver
Copy link
Contributor Author

tseaver commented Sep 24, 2016

I've rebased it to resolve the conflict in .gitignore.

If we automated building the Dash docsets and pushing them to Dash as part of our tag-release deployment, that seems like a low-cost win to me: users who like using offline docs will be able to consume them with their preferred tool.

PYTHONPATH = {toxinidir}/_testing
basepython = {[testenv:docs]basepython}
commands =
sphinx-build -W -b html -d docs/_build_doc2dash/doctrees docs docs/_build_doc2dash/html

This comment was marked as spam.

@dhermes
Copy link
Contributor

dhermes commented Sep 25, 2016

@tseaver Feel free to merge when my request is addressed.

Are you going to automate the process of creating and publishing this target?

Replace 'gcloud-python' with 'google-cloud-python' in docset name.
@tseaver tseaver merged commit 4258b76 into googleapis:master Sep 26, 2016
@tseaver tseaver deleted the docs-add_doc2dash_tox_target branch September 26, 2016 15:03
@tseaver
Copy link
Contributor Author

tseaver commented Sep 26, 2016

Are you going to automate the process of creating and publishing this target?

I'm thinking about it. There seem to be two options:

Automating the first seems quite feasible; the second seems infeasible.

atulep pushed a commit that referenced this pull request Apr 6, 2023
…udPlatform/python-docs-samples#1702)

* Update enhanced models and auto punctuation to GA

* Update model-slection to GA
atulep pushed a commit that referenced this pull request Apr 6, 2023
…udPlatform/python-docs-samples#1702)

* Update enhanced models and auto punctuation to GA

* Update model-slection to GA
atulep pushed a commit that referenced this pull request Apr 18, 2023
…udPlatform/python-docs-samples#1702)

* Update enhanced models and auto punctuation to GA

* Update model-slection to GA
parthea pushed a commit that referenced this pull request Oct 22, 2023
…udPlatform/python-docs-samples#1702)

* Update enhanced models and auto punctuation to GA

* Update model-slection to GA
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants