Hi Ritesh,

On Thu, 01 Aug 2019 14:24:59 +0530, Ritesh Raj Sarraf wrote :
> Hello Kenneth,
> 
> On Wed, 2019-07-31 at 21:17 -0500, Kenneth Pronovici wrote:
> > Hi,
> > 
> > I just wanted to follow up on  python-configshell-fb.  Back in June,
> > you marked a pending upload to remove the epydoc dependency, but the
> > bug is still open.   I've filed the package removal request for
> > epydoc, and I'm working through all of the reverse dependencies to
> > adjust them, so the package removal can proceed.  Could you please
> > upload your new package sometime soon?  It would help simplify things
> > for me.
> 
> So I didn't pay very close attention back when I disabled the
> dependency on epydoc.
> 
> Thing is, we are shipping a package for the documentation, python-
> configshell-fb-doc, which contains the epydoc generated documentation
> files. If I drop the epydoc dependency, I am left with an empty package
> that I'll have to drop. I would rather prefer to see it still carry the
> documentation.
> 
> I just checked on the upstream project page and didn't see any bug
> reports about the unmaintained epydoc dependency. Maybe they are
> unaware of epydoc's current state.

There is no bug report upstream, but I created a branch to remove the
epydoc dependency entirely a few days ago. This branch has not been
merge yet.

See:

  https://github.com/open-iscsi/configshell-fb/pull/51


> I think best would be to migrate the documentation to the new sphinx
> format you mentioned some time back.

As for the documentation, there is not much epydoc markup in
configshell-fb. It is mostly used to extract the message for the help
commands from the docstrings (e.g. `help ls`, `help create`) and nicely
format it to the console. Except that the nice formatting does not work
most of the time because configshell-fb and targetcli-fb are running on
Python 3 where epydoc is missing.

Hope that helps,


> My knowledge on documentation is very limited and so is the time these
> days. So, if you can help me (or upstream directly) here, that'd help
> expedite the upload without the epydoc dependency.
> 
> Thanks,
> Ritesh
> 


-- 
Christophe Vu-Brugier

Reply via email to