Skip to content

Conversation

@tschm
Copy link
Contributor

@tschm tschm commented Nov 27, 2025

Added clean and deptry targets to the Makefile.
Add also the book target.

Try "make book" and watch out for the _book and _tests folders
The "make book" can also be triggered during ci/cd and it is possible to upload the book as webpage.
Currently the book only features test and coverage reports.
We can also include notebooks and documentation...

@fkiraly
Copy link
Collaborator

fkiraly commented Nov 27, 2025

I get clean and deptry, but what does book do? Would appreciate an explanation.

@fkiraly fkiraly added the maintenance Continuous integration, unit testing & package distribution label Nov 27, 2025
@tschm
Copy link
Contributor Author

tschm commented Nov 28, 2025

Book is constructing a static webpage collecting test reports, test coverage etc.

@tschm
Copy link
Contributor Author

tschm commented Nov 28, 2025

An example for a book is given here https://tschm.github.io/pyhrp/.

@fkiraly
Copy link
Collaborator

fkiraly commented Nov 29, 2025

does this mean, you are suggesting to migrate the documentation from readthedocs to book?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Continuous integration, unit testing & package distribution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants