Skip to content

0.3.0 - From Scratch
Compare
Choose a tag to compare
@vemel vemel released this 25 Oct 12:26
0.3.0
96b991a

Features

New Python code parsing approach

Now handsdown uses Abstract Syntax Trees (AST) to parse a source code. Code was completely rewritted, but now it is better, faster, and does not require your project dependencies installed. py27 support is dropped, but you can use a new Docker image for Python 2.x projects.

Comment docstrings

# Name for main `logging.Logger`
PROJECT_NAME = 'my_project'

# Format for logs views.
DATE_FORMAT = '%Y-%m-%d'

Ever had something like this in your source code? Well, now it is added to docs and even is discoverable by referencing from other modules, like

from my_project.constants import DATE_FORMAT

def parse_date(date_str, format=DATE_FORMAT):
   return datetime.strptime(date_str, format)

This will generate a nice See also link to your constants.md file.

Same result for all Python version

All py3x produce exactly the same result.

New function signature generator

This comes together with AST introduction. Now signature is properly indented and slit to multiple lines if needed.

Bugfixes

  • Fix wrong ToC indentation for mkdocs (use 4 spaces indent)
  • Fix wrong target file for See also links
  • Fix source code link for py38, so it include decorators
  • Fix source lookup for pathlib2 fallback (it is very buggy)
  • Fix orphaned docs cleanup for pathlib2 fallback
  • Speed up doc generation on big projects

Changes

  • Add --name CLI parameter
  • Python 3.5.+ is now required
Assets 3
Loading