sphinx-nested-apidoc

v1.2.6 (2023-10-19)

Refactor

• main: typevar bound should be int (#225)

v1.2.5 (2023-10-16)

Fix

• logging: count verbose flag to gradually increase loglevel (#215)

v1.2.4 (2023-08-01)

Refactor

• remove magic numbers and add linting rules (#153)

v1.2.3 (2023-05-27)

Refactor

• core: use Path instead of bare os.path manipulations
• core: change variable name from p to path_

v1.2.2 (2022-12-26)

Fix

• core: use shutil.move to move/rename files

v1.2.1 (2022-11-06)

Refactor

• ext: make ext an internal module

v1.2.0 (2022-10-28)

Feat

• ext: add rename_destdir_to as extension argument
• main: add CLI flag to specify the name of directory in output dir
• core: allow renaming of generated package directory
• export setup function for sphinx
• ext: allow sphinx-nested-apidoc to be used as a sphinx extension
• core: allow caller to specify excluded files and check if given path is a file
• core: clean up leftover files if files are not renamed

Fix

• ext: remove unused and redundant configuration values
• core: handle santization of names when name is like .name
• main: check if rename_destdir_to is None
• main: remove erroneous --output-dir flag

Refactor

• core: log when creating directory
• main: rename cli argument to --package-name
• core: make sanitize_path a public function and remove unnecessary caching
• main: display complete Exception info on failure
• core: rename args to sphinx_arguments

Perf

• main: sanitize argument beforehand to avoid unnecessary caching
• core: prevent repeated calls to os.makedirs
• core: cache the argument of is_packagedir

v1.1.1 (2022-10-12)

Fix

• main: remove unnecessary exception blocks; return int from main

v1.1.0 (2022-10-12)

Feat

• main: allow passing list of str to main; pass force flag for renaming
• core: use apidoc.main instead of subprocess; use force flag for renaming

v1.0.0 (2022-10-12)

BREAKING CHANGE

• Previously it ignored the topmost directory, ie. a file
  of name a.b.c.rst would have the name b/c.rst. Now for a.b.c.rst,
  a/b/c.rst is generated.

Feat

• core: process additional arguments and raise error if command fails
• main: add additional flags to parser
• core: handle namespace and packages properly

Refactor

• init: change the logger format to include filename:lineno
• init: use % formatting and add __future__ import
• move codebase into src directory