Giter Club home page Giter Club logo

automatic-mkgendocs's People

Contributors

jeremydiba avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

automatic-mkgendocs's Issues

Documentation not working

Hey Jeremy,
thanks for the script creation and the article but for some reason I am not able to make it work.
I have a repository with the following structure.

./
./docs/
./module_to_document
./module_to_document/__init__.py
./module_to_document/tools.py
....
./module_to_document/tests
./module_to_document/tests/test_tools.py
....
./automate_mkdocs.py
./mkdocs.yml
./mkgendocs.yml

When I run the script automate_mkdocs.py the output is
trouble on importing tools
did not document <function_name>
No module named './module_to_document/tools'

The issue is due to this line module = importlib.import_module(relative_path)
I am running python 3.9

Any idea how to resolve the issue and make your code work.

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.