Giter Site home page Giter Site logo

Modules docs about python-graphenelib HOT 4 CLOSED

xeroc avatar xeroc commented on May 22, 2024
Modules docs

from python-graphenelib.

Comments (4)

xeroc avatar xeroc commented on May 22, 2024

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.

from python-graphenelib.

bitphage avatar bitphage commented on May 22, 2024

@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.

from python-graphenelib.

xeroc avatar xeroc commented on May 22, 2024

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

from python-graphenelib.

bitphage avatar bitphage commented on May 22, 2024

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

from python-graphenelib.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.