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

Automatically generate mkdocs.yml #100

Closed
mortenpi opened this issue Jun 17, 2016 · 6 comments
Closed

Automatically generate mkdocs.yml #100

mortenpi opened this issue Jun 17, 2016 · 6 comments
Labels

Comments

@mortenpi
Copy link
Member

This is a bit future looking, but mkdocs.yml must contain structural information about the docs (pages: section), and this could be generated automatically.

For other formats (e.g. #3) we need to figure out the general structure of the pages anyway and we might even need our own version of mkdocs.yml. Once that is in, should we also extend that to mkdocs generation to have a consistent way of structuring docs with Documenter?

@MichaelHatherly
Copy link
Member

Been wondering how we should handle this, thanks for opening an issue for it.

Perhaps we should define the necessary data in make.jl just as a datastructure (Dict or something) rather than needing to parse a separate config for this. Then pass that to makedocs/deploydocs when needed.

@TotalVerb
Copy link
Contributor

I think this is a great idea! Sometimes I want to have stuff in extra that depends on the version, like:

extra:
  version: 0.3.2

for the material theme. I think generating mkdocs.yml is the only way to allow this kind of variance between versions.

@hayd
Copy link
Contributor

hayd commented Jun 18, 2016

see in the distant past MichaelHatherly/Docile.jl@dc67ad8

related: documentation ordering (#13)

@MichaelHatherly
Copy link
Member

(Thanks for linking to that one @hayd.)

@alansoliditydev
Copy link

Hello, how about this feature, guys?

@mortenpi mortenpi added the Format: Markdown Related to the Markdown output label Jun 16, 2019
@odow
Copy link
Collaborator

odow commented Oct 31, 2023

I'm doing a triage of open documenter issues and closing issues that are stale. If I've made a mistake, please re-open

Closing because Documenter no longer supports mkdocs.

@odow odow closed this as completed Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

6 participants