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.

Sign up for GitHub

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

Jump to bottom

Add ability to pull snippets when generating JSON documentation #1951

Closed
daspecster opened this issue Jul 1, 2016 · 4 comments
Closed

Add ability to pull snippets when generating JSON documentation #1951

daspecster opened this issue Jul 1, 2016 · 4 comments
Assignees
@daspecster

Comments

@daspecster
Copy link
Contributor

We have a lot of great snippet code that we should be able to include when we generate docs.

See: pubsub_snippets.py
@daspecster daspecster added the docs label Jul 1, 2016
@tseaver
Copy link
Contributor

tseaver commented Jul 8, 2016

FTR, those snippets are embedded into Sphinx narrative docs and into docstrings via the .. literalinclude: directives.

@daspecster
Copy link
Contributor Author

Yeah, I will need to recreate the literalinclude directive functionality and add the ability to parse the files and START and END sections.

@daspecster
Copy link
Contributor Author

Currently the generator isn't pulling in any RST files. Grabs the doc strings from the modules/classes/methods/functions.

What I'm thinking of doing just for right now is just grabbing the snippets and populating the examples = [] with the snippets.

@tseaver, do you think it would be possible to move the snippets to the module/class/etc doc strings later on or would that make things too messy?

@daspecster daspecster mentioned this issue Jul 12, 2016
Merged
13 tasks
daspecster added a commit to daspecster/google-cloud-python that referenced this issue Jul 13, 2016
@daspecster
Add snippets to base service module. closes googleapis#1951
b621d1f
@daspecster
Copy link
Contributor Author

Added to #1775.

daspecster added a commit to daspecster/google-cloud-python that referenced this issue Jul 20, 2016
@daspecster
Add snippets to base service module. closes googleapis#1951
7ffd691
daspecster added a commit to daspecster/google-cloud-python that referenced this issue Jul 20, 2016
@daspecster
Initial update to generate json docs
d606735 
Testing deploy with 1:1 class:json.

Add overview.html

Deploy script working now in testing.

Fix code blocks.

Add href support.

Add snippets to base service module. closes googleapis#1951

Fix types generation.

Fix linking.

Fix external github links.

Update gcloud-commit site files.

Swtich to live site generation.

clean up manifest for starters.

Remove old example detection code.

Update TOC.
daspecster added a commit to daspecster/google-cloud-python that referenced this issue Jul 20, 2016
@daspecster
Initial update to generate json docs
de3d16f 
Testing deploy with 1:1 class:json.

Add overview.html

Deploy script working now in testing.

Fix code blocks.

Add href support.

Add snippets to base service module. closes googleapis#1951

Fix types generation.

Fix linking.

Fix external github links.

Update gcloud-commit site files.

Swtich to live site generation.

clean up manifest for starters.

Remove old example detection code.

Update TOC.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@daspecster daspecster

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@daspecster @tseaver