[hawkmoth] Re: [RFC] collection of generic functional and usability fixes

  • From: Jani Nikula <jani@xxxxxxxxxx>
  • To: Bruno Santos <brunomanuelsantos@xxxxxxxxxxxxxxxxxx>, hawkmoth@xxxxxxxxxxxxx
  • Date: Sun, 09 Dec 2018 23:16:57 +0200

On Thu, 06 Dec 2018, Bruno Santos <brunomanuelsantos@xxxxxxxxxxxxxxxxxx> wrote:

Hey Jani,

I've now played around with this a bit and I accumulated a few patches
that I'd like to see merged in some form. Things I'd like to point out
are:

Bruno, thanks so much for the patches! I'm replying here for better
context, but I did use the code from your updated pull request from
unrot-v2 branch.

* Python 3 is now mandatory:

  Not sure what you meant the other day on IRC about abandoning Python
  2 once we changed to a different Clang interface. Current bindings
  seem fine to me.

As discussed, Debian still doesn't have Python 3 Clang bindings
available. I was able to make it work for me, though, and I have no
qualms about dropping Python 2 support soon. That said, I've slightly
modified some of your changes to retain Python 2 support for a wee bit
longer.

* I've provisionally set the required Sphinx version at 1.8:

  I think this is quite aggressive, but it's what I could easily (and
  cared for) testing. My work machine is Debian and only ships 1.4 and
  that will _not_ work, But I think 1.7 and probably 1.6 should be
  good. Which version are you on?

I'm fine with the 1.8 requirement, and I've merged the patch. If people
show up who require earlier versions, I'll accept reasonable patches to
make it work.

* Documentation:

  There's quite a bit of documentation clean up, but I wonder if some of the
  documentation in 'extension.rst' should be moved in-source and included
  through autodoc.

  It would be nice to access module documentation through e.g. pydoc. It would
  also be well in the spirit of what this project tries to achieve.

Didn't get this far yet.

I haven't yet touched the hawkmoth module. My plan is to split it up
in a bunch of different modules so that it's clearer where new
features must go, but it can be done independently.

Sounds good!

Not sure how you prefer to handle pull requests: kernel style or
GitHub. I prefer email, but I've set up a mirror in GitHub so I can
interact that way as well if you prefer.

I'm fine with emailed patches, emailed pull requests, and I can live
with github pull requests too. The only problem here was the gitlab url
that required a gitlab account; the anonymous url in v2 worked fine.

Let me know what you think.

Absolutely thrilled to get some traction to the project!


Cheers,
Bruno


--8<------


The following changes since commit a6e52a1389e121e4125cd11ca8a84afc3f729914:

  cautodoc: Sphinx counts lines from 0 (2017-09-04 19:09:31 +0300)

are available in the Git repository at:

  git@xxxxxxxxxx:bms-contrib/hawkmoth.git unrot

for you to fetch changes up to 61ffcbc35ef6c1f1c771c5554400daeae64bec95:

  doc: reference available installation packages (2018-12-06 00:42:35 +0100)

----------------------------------------------------------------
Bruno Santos (13):
      cautodoc: fix dependency on deprecated module
      cautodoc: drop usage of deprecated AutodocReporter
      cautodoc: bump Sphinx version requirement
      cautodoc: fix module imports
      cautodoc: make source a bit more 'pythonic'
      doc: make RTD theme dependency optional
      doc: fix build warning due to missing files
      doc: update conf.py to match the newer template

Merged up to and including this one, with some minor changes.

      doc: enable extensions to automate documentation
      doc: clean up package documentation
      doc: clean up syntax documentation
      doc: clean up README
      doc: reference available installation packages

Haven't looked at these yet.

Thanks,
Jani.


 README.rst           |  32 +++---
 doc/conf.py          | 318 
++++++++++++++-------------------------------------
 doc/extension.rst    |  80 +++++++------
 doc/syntax.rst       |  26 ++---
 hawkmoth/__init__.py |  99 ++++++++++++++++
 hawkmoth/cautodoc.py | 100 ----------------
 6 files changed, 249 insertions(+), 406 deletions(-)
 delete mode 100644 hawkmoth/cautodoc.py


-- 
Bruno Santos

PGP KEY: 941052CD (pool.sks-keyservers.net)

Other related posts: