search

doorstop-dev / doorstop

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

Rework of HTML publisher. #622

Closed neerdoc closed 7 months ago

neerdoc commented 7 months ago

Updated both the HTML-publisher and the doorstop-server to user a new layout with a top menu instead of the sidebar, which fixes #327. By upgrading to newer version of bootstrap, the dependency of jquery was removed.

The change also includes the possibility for the users to create really custom HTML exports as the .tpl files are now included in the publishing process so that a user can included custom Bottle-template files as well.

Installed a local copy of MathJax so that offline installations work properly.

I also included support for the document attributes that was included for LaTeX publishing, so that the HTML publish also has this information, which fixes #26.

A few bugs that were not yet reported were also fixed, mainly a problem with the #615 PR which had introduced an error when publishing a single document that I did not catch earlier.

Further testing also resulted in reworking the Markdown publishing since links between items where broken, which fixes #378. Since publishing now is separated it was easy to fix without affecting the other formats. This also lead to fixing #469 since the extra space caused havoc to the links.

This PR might also fix #515. After it's been published it would be nice with some feedback on if this is good enough for that issue.

Some dependencies have also been updated and a lot of new test cases to get better coverage on the changed parts of the code.

Also added a couple of new dev-dependencies so that the API server calls can be tested and it is now possible to run make test-cover to get immediate feedback on if the changed code is covered by tests of not (instead of waiting for the CI-job to run).

codecov-commenter commented 7 months ago

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (d134211) 95.40% compared to head (ce58564) 96.31%. Report is 2 commits behind head on develop.

:exclamation: Current head ce58564 differs from pull request most recent head aabbe88. Consider uploading reports for the commit aabbe88 to get more accurate results

Files Patch % Lines
doorstop/__init__.py 66.66% 1 Missing :warning:

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

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #622 +/- ## =========================================== + Coverage 95.40% 96.31% +0.90% =========================================== Files 41 41 Lines 5053 5150 +97 Branches 1184 962 -222 =========================================== + Hits 4821 4960 +139 + Misses 147 119 -28 + Partials 85 71 -14 ```

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

neerdoc commented 7 months ago

Will add more tests to cover all changes I made. Don't merge yet... :)