Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to specify which sections to keep #604

Open
stefanogermano opened this issue Aug 2, 2023 · 1 comment
Open

Ability to specify which sections to keep #604

stefanogermano opened this issue Aug 2, 2023 · 1 comment
Assignees
Labels
new feature request for supporting a new feature pressing Will fix issue in next release
Milestone

Comments

@stefanogermano
Copy link

Is your feature request related to a problem? Please describe.

Often you want to keep some sections but overwrite everything else.
This is not possible at the moment (except for some very specific cases).

Describe the solution you'd like

It would be useful a "exclude" (or "except for") option to use in combination with "rewriteAll", where you can specify all the section you do not want to be overwritten. That would be very flexible, and you would not have to implement all the combinations (of different sections).

So we could say something like -rewriteAll -exclude introduction-description-references, and this will keep the content of those sections (but it can also be used to exclude any other combination of sections).

Describe alternatives you've considered

I saw that there is an -excludeIntroduction option, but that is just for the "Introduction" section, and it seems to exclude completely the introduction (even in the index).
My proposal is to keep the content that is already there (i.e., not remove the section), and it is (obviously) more generic.

@dgarijo dgarijo added pressing Will fix issue in next release new feature request for supporting a new feature labels Aug 10, 2023
@dgarijo dgarijo self-assigned this Aug 10, 2023
@dgarijo dgarijo added this to the v1.4.xx milestone Aug 10, 2023
@dgarijo dgarijo modified the milestones: v1.4.xx, v1.X.0 Aug 29, 2023
@idomingu
Copy link

+1 to this feature. For example, it would be useful to regenerate the whole documentation except for the "Description" section, which I later edit manually (more convenient when including images, examples, etc.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature request for supporting a new feature pressing Will fix issue in next release
Projects
None yet
Development

No branches or pull requests

3 participants