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

  • From: Bruno Santos <brunomanuelsantos@xxxxxxxxxxxxxxxxxx>
  • To: jani@xxxxxxxxxx, hawkmoth@xxxxxxxxxxxxx
  • Date: Thu, 6 Dec 2018 01:26:01 +0100

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:

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

* 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?

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


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.

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.


Let me know what you think.

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

 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)



Attachment: signature.asc
Description: OpenPGP digital signature

Other related posts: