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

improve preview-ability of submodule changes #11

Open
jothepro opened this issue Jan 20, 2021 · 0 comments
Open

improve preview-ability of submodule changes #11

jothepro opened this issue Jan 20, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@jothepro
Copy link
Contributor

jothepro commented Jan 20, 2021

As a developer I want to be able to easily preview my changes. To make sure everything is fine, I want them to be as close as possible to what they will look like in production.

Currently all submodules do just have a minimal mkdocs configuration file & will render with the default mkdocs theme. This can lead to inaccuracies in the preview if I edit the documentations of just one submodule repository, without rendering the full documentation page. Certain features/plugins are not supported/enabled in the submodule mkdocs configurations.

To achieve a setup closer the the real configuration in each repository, the docs should be configured to render with the current theme from the main documentation repository by default (material for Mkdocs), and with the same plugins activated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant