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

doc: add ReST doc generation #537

Merged
merged 4 commits into from
Oct 7, 2017
Merged

doc: add ReST doc generation #537

merged 4 commits into from
Oct 7, 2017

Conversation

shahidhk
Copy link
Contributor

@shahidhk shahidhk commented Oct 1, 2017

Added GenReST commands to generate docs in ReStructured Text format.

This is exactly similar to GenMan and GenMd commands. To deal with document processors like Sphinx, which can cross link documents using :ref: tags, linkHandler function can be used.

@CLAassistant
Copy link

CLAassistant commented Oct 1, 2017

CLA assistant check
All committers have signed the CLA.

@n10v
Copy link
Collaborator

n10v commented Oct 1, 2017

LGTM
/cc @eparis

@shahidhk
Copy link
Contributor Author

shahidhk commented Oct 7, 2017

@BoGeM @eparis Any update on this? Thanks

@n10v
Copy link
Collaborator

n10v commented Oct 7, 2017

Please add a reference to docs in README as it shown here.

@shahidhk
Copy link
Contributor Author

shahidhk commented Oct 7, 2017

@BoGeM Done. I have also combined all three document generation headings into one. Hope that's fine.

@n10v
Copy link
Collaborator

n10v commented Oct 7, 2017

Please resolve conflicts and add link to Table of Contents.

@shahidhk
Copy link
Contributor Author

shahidhk commented Oct 7, 2017

@BoGeM sorry about that. I have merged master and fixed conflicts, also added to ToC

@shahidhk
Copy link
Contributor Author

shahidhk commented Oct 7, 2017

Looks like some tests are failing on circleci:

--- FAIL: TestNormConsistent (0.00s)
	cobra_test.go:1253: Normalizing flag names should not result in duplicate flags

happened on my local too. But passed on travis.

@n10v
Copy link
Collaborator

n10v commented Oct 7, 2017

happened on my local too

Update pflag on your machine: go get -u github.com/spf13/pflag

@n10v n10v merged commit 419e0f8 into spf13:master Oct 7, 2017
@n10v
Copy link
Collaborator

n10v commented Oct 7, 2017

Thank you for your PR!

@shahidhk
Copy link
Contributor Author

shahidhk commented Oct 7, 2017

Thanks @BoGeM for guiding me through this.

@shahidhk shahidhk deleted the sphinx-docs branch October 7, 2017 18:17
@shahidhk shahidhk restored the sphinx-docs branch October 7, 2017 18:20
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.

3 participants