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

Clean up doc build #754

Merged
merged 3 commits into from Dec 21, 2016
Merged

Clean up doc build #754

merged 3 commits into from Dec 21, 2016

Conversation

chadwhitacre
Copy link
Contributor

Good docs build cleanly!

@chadwhitacre chadwhitacre changed the title Build docs during CI to catch out errors Clean up doc build Dec 21, 2016
@chadwhitacre chadwhitacre changed the title Clean up doc build [WIP] Clean up doc build Dec 21, 2016
@chadwhitacre
Copy link
Contributor Author

(cloud-custodian) $ sphinx-build -W docs/source docs/build -q 2>&1 | less
(cloud-custodian) $

This adds the API reference docs to the site navigation, so we can start
to see just how bad they are. :)
@chadwhitacre
Copy link
Contributor Author

Ready for review. Note that this brings the API reference into the docs. Are we ready for that? If not we can turn off sphinx-apidoc (building w/o linking in the ToC throws a warning).

screen shot 2016-12-21 at 8 49 24 am

@chadwhitacre chadwhitacre changed the title [WIP] Clean up doc build Clean up doc build Dec 21, 2016
@@ -89,7 +89,7 @@ def type_schema(
inherits issues with additionalProperties and type enums.
- aliases: additional names this type maybe called
- required: list of required properties, by default 'type' is required
- **props: additional key value properties
- props: additional key value properties
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't the ** be escaped rather than deleting it?

@kapilt
Copy link
Collaborator

kapilt commented Dec 21, 2016

i'm fine with it for now, i just don't think auto module docs reflects end target state, where reference docs are not nesc a code docs but a policy authoring reference thats autogen'd from registered resource types and their respective filters/actions. but its a good step forward.

Copy link
Collaborator

@kapilt kapilt left a comment

Choose a reason for hiding this comment

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

lgtm

@kapilt kapilt merged commit 24bdc7a into cloud-custodian:master Dec 21, 2016
@chadwhitacre chadwhitacre deleted the docs-ci branch December 23, 2016 14:38
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.

None yet

3 participants