Skip to content

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

Merged
tseaver merged 2 commits into
googleapis:masterfrom
tseaver:docs-add_doc2dash_tox_target
Sep 26, 2016
Merged

Add a 'docs-doc2dash' Tox target.#1702
tseaver merged 2 commits into
googleapis:masterfrom
tseaver:docs-add_doc2dash_tox_target

Conversation

@tseaver

@tseavertseaver commented Apr 7, 2016

Copy link
Copy Markdown
Contributor

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.

@tseavertseaver added the docs label Apr 7, 2016
@googlebotgooglebot added the cla: yes This human has signed the Contributor License Agreement. label Apr 7, 2016
@dhermes

dhermes commented Apr 7, 2016

Copy link
Copy Markdown
Contributor

Do we actually need this?

@jgeewax

jgeewax commented Apr 7, 2016

Copy link
Copy Markdown
Contributor

Yea - confused. What's the goal ?

@tseaver

tseaver commented Apr 7, 2016

Copy link
Copy Markdown
ContributorAuthor

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

daspecster commented Jul 13, 2016

Copy link
Copy Markdown
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

dhermes commented Sep 23, 2016

Copy link
Copy Markdown
Contributor

@tseaver Shall we close this PR?

@tseaver
Add a 'docs-doc2dash' Tox target.
1523452
Generates a Dash-style docset from the Sphinx-rendered HTML.
@tseaver

tseaver commented Sep 24, 2016

Copy link
Copy Markdown
ContributorAuthor

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.

dhermes
dhermes reviewed Sep 25, 2016
View reviewed changes
Comment threadtox.ini Outdated
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.

Sign in to view

@dhermes

dhermes commented Sep 25, 2016

Copy link
Copy Markdown
Contributor

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

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

@tseaver
Wrap long lines.
3df4ceb
Replace 'gcloud-python' with 'google-cloud-python' in docset name.
@tseaver
tseaver merged commit 4258b76 into googleapis:masterSep 26, 2016
@tseaver
tseaver deleted the docs-add_doc2dash_tox_target branch September 26, 2016 15:03
@tseaver

tseaver commented Sep 26, 2016

Copy link
Copy Markdown
ContributorAuthor

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.

@dhermesdhermes mentioned this pull request Sep 29, 2016
Closed
atulep pushed a commit that referenced this pull request Apr 6, 2023
@nnegrey@busunkim96
Update enhanced models and auto punctuation to GA [(#1702)](GoogleClo…
2795bfe
…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
@nnegrey@busunkim96
Update enhanced models and auto punctuation to GA [(#1702)](GoogleClo…
1138817
…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
@nnegrey@busunkim96
Update enhanced models and auto punctuation to GA [(#1702)](GoogleClo…
0bdcc40
…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
@nnegrey@busunkim96
Update enhanced models and auto punctuation to GA [(#1702)](GoogleClo…
e1fbb31
…udPlatform/python-docs-samples#1702)
* Update enhanced models and auto punctuation to GA
* Update model-slection to GA
parthea added a commit that referenced this pull request Nov 24, 2025
@renovate-bot@parthea
chore(deps): update all dependencies (#1702)
62625b3
* chore(deps): update all dependencies
* revert
---------
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea pushed a commit that referenced this pull request Apr 1, 2026
@sycai
feat: support () operator between timedeltas (#1702)
68c146e
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@dhermesdhermesdhermes left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cla: yesThis human has signed the Contributor License Agreement.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@tseaver@dhermes@jgeewax@daspecster@googlebot