search

alendit / sphinx-pyreverse

Simple sphinx wrapper around pyreverse (from pylint suit) to generate UML diagramms from modules.
GNU General Public License v3.0
48 stars 20 forks source link

Feature/make configurable #15

Closed doublethefish closed 3 years ago

doublethefish commented 4 years ago

In this commit we attempt to address the issues discussed in #4 and #5.

First all configurations specified in pyreverse --help can now be configured in conf.py - see the updated README for details.

We also allow overrides of the 'uml' directive via an environment variable - it is the least-bad of all worlds. Until a decision is made to port from 'uml' to some other keyword. My concern is back-compatibility on that one.

doublethefish commented 4 years ago

It's worth mentioning that I have done very little testing of the conf.py options, to validate that they work. Because I just pass through the configuration options to pyreverse's command line, if the option is set, I assume that the command will pass/fail in the same way as if you'd passed them directly on the command line.

To help identify any problems that users might have, we now log-out the command being run so they can intergogate/copy/paste/use it and log issues here.

Experience dictates that it is likely there's at least one issue with this, but I feel this is good-enough for now.

doublethefish commented 3 years ago

@alendit would you like to merge this and release?

doublethefish commented 3 years ago

@alendit can you merge and release this to pip?