search

doorstop-dev / doorstop

Requirements management using version control.
https://doorstop.readthedocs.io
Other
480 stars 131 forks source link

Add markdown index support #661

Closed robtaylor closed 1 month ago

robtaylor commented 1 month ago

This PR adds support for generating a top level index in markdown, similar to the HTML publishing backend.

It also contains adding markdown's requirements into its generated docs, mainly by way of an example of usage - I expect this will need some work if it is desirable!

codecov-commenter commented 1 month ago

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 97.14286% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.44%. Comparing base (7865edf) to head (2947607). Report is 9 commits behind head on develop.

Files with missing lines Patch % Lines
doorstop/core/publishers/markdown.py 96.87% 0 Missing and 1 partial :warning:

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #661 +/- ## ======================================== Coverage 96.44% 96.44% ======================================== Files 40 40 Lines 5198 5231 +33 Branches 1226 1234 +8 ======================================== + Hits 5013 5045 +32 Misses 110 110 - Partials 75 76 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.