search

jolly-good-toolbelt / sphinx_gherkindoc

A tool to convert Gherkin into Sphinx documentation
https://jolly-good-toolbelt.github.io/sphinx_gherkindoc/
11 stars 10 forks source link

When feature files are excluded with the --include-tags, the TOC tree includes references to missing files #43

Closed rbcasperson closed 4 years ago

rbcasperson commented 4 years ago

When #40 was added, it failed to consider the TOC tree file. If feature files are included, then the rst file isn't created for them, but the TOC tree still references them. This is because the TOC tree file is created before filtering the feature files. Also, this logic is at the cli.py level, which currently has no tests.

This causes a warning when building sphinx, which isn't really a major issue, but I have a use case where we lint the docs and treat warnings as failures.

This is something I plan to work on, but I wanted to document it properly first.