xeroc / python-graphenelib

Python3 library for Graphene-based blockchains
MIT License
74 stars 60 forks source link

Modules docs #134

Closed bitphage closed 4 years ago

bitphage commented 4 years ago

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 commented 4 years ago

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.

bitphage commented 4 years ago

@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 commented 4 years ago

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 commented 4 years ago

Oh I didn't noticed sphinx-apidoc call from Makefile, thanks. :man_facepalming: