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

Modules docs #134

Closed
bitphage opened this issue Dec 9, 2019 · 4 comments
Closed

Modules docs #134

bitphage opened this issue Dec 9, 2019 · 4 comments

Comments

@bitphage
Copy link
Contributor

bitphage commented Dec 9, 2019

For each module there is file like graphenebase.memo.rst. I suggest to auto-generate such files via sphinxcontrib-apidoc module, would you not mind if I add this into my further PR?

@xeroc
Copy link
Owner

xeroc commented Dec 19, 2019

https://github.com/xeroc/python-graphenelib/blob/master/Makefile#L45

The makefile also has a release that runs through semversioner for automatically pushing verison number and providing a CHANGELOG.

@xeroc xeroc closed this as completed Dec 19, 2019
@bitphage
Copy link
Contributor Author

@xeroc how does semversioner solves generating documentation? This:

graphenecommon.vesting module
=============================

.. automodule:: graphenecommon.vesting
    :members:
    :undoc-members:
    :show-inheritance:

I say this could be autogenerated.

@xeroc
Copy link
Owner

xeroc commented Jan 14, 2020

In the Makefile:

docs:
        sphinx-apidoc -d 6 -e -f -o docs . *.py tests
        # or SPHINX_APIDOC_OPTIONS="members,undoc-members,show-inheritance,inherited-members" sphinx-apidoc -d 6 -e -f -o docs . *.py tests
        make -C docs clean html

For make release:

prerelease: test docs docs_store authors authors_store
release: prerelease semver clean build check dist upload git

@bitphage
Copy link
Contributor Author

Oh I didn't noticed sphinx-apidoc call from Makefile, thanks. 🤦‍♂️

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

No branches or pull requests

2 participants