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

Feature: Allow literal-include of arbitrary project files #107

Open
marble opened this issue Dec 10, 2020 · 0 comments
Open

Feature: Allow literal-include of arbitrary project files #107

marble opened this issue Dec 10, 2020 · 0 comments
Assignees
Labels
feature An improvement or feature request

Comments

@marble
Copy link
Contributor

marble commented Dec 10, 2020

Situation

Documentation usually is only a part of a total project with relevant files only in the root folder PROJECT/ and the subfolder tree at PROJECT/Documentation. So our container usually only cares about the root folder and the Documentation/... tree. This is done by intention, as project may happen to be huge.

Desire

Sometimes it would be nice, however, if the documentation could refer directly to real project files lying outside documentation, so there could be includes like .. literal-include:: /PROJECT/Php/Classes/...

Implications

This is conceivable, if the rendering toolchain at some point checks the include directives (which is already done any way) and copies those external, referenced project file into the documentation.

@marble marble self-assigned this Dec 10, 2020
@marble marble changed the title Feature request: Allow literal-include of arbitrary project files Feature: Allow literal-include of arbitrary project files Dec 10, 2020
@marble marble added feature An improvement or feature request postpone Will not make it into the next release labels Dec 10, 2020
@marble marble added this to the Future version v2.8 milestone Dec 10, 2020
@marble marble removed the postpone Will not make it into the next release label Jan 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature An improvement or feature request
Projects
None yet
Development

No branches or pull requests

1 participant