boostorg / boostorg/geometry

Improve doxygen files clean-up

Open
#388 0 comments 0 reactions 1 assignee Claimed by @mloskot View on GitHub
documentation enhancement
Dominant language
C++
Stars
517
Forks
232
PR merge metrics
No merged PRs in 30d

Description

Task to improve changes from PR #387

Below are suggestions from @awulkiew which I intend to work on:

------

Instead of clearing out the index dir in the `index/make_qbk.py` and doing the same in the `make_qbk.py`, `index/make_qbk.py` could be executed with `--release-build` option and cleanup related to the index could be done only there.

There are generated `*.qbk` files in directories doc/generated and doc/index/generated which are not needed. Also `doc/html/geometry_HTML.manifest` file. Ideally they probably should be removed as well, but this should be done after `b2` is called. But since `b2` can run `make_qbk.py` and the script is then executed before quickbook it is impossible to implement the cleanup of generated qbk files in this single script. Maybe it could be done in a separate cleanup script run by b2 after building docs from qbk files, but I don't know how exactly.

------

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.