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

Documentation ordering #13

Closed
hayd opened this issue Jan 10, 2016 · 2 comments
Closed

Documentation ordering #13

hayd opened this issue Jan 10, 2016 · 2 comments

Comments

@hayd
Copy link
Contributor

hayd commented Jan 10, 2016

At the moment, all the md files are built and dumped into build.

If using mkdocs (#10) these have to be specified in the yaml. One could do the same in a top level latex file to input these and add style. This seems like a duplication of effort (specifying the ordering).

I would propose, either:

  1. mkdocs.yml pages-section is required, use this to decide the ordering and naming of sections. Warn/error if sections are missing in both src or yaml. Use this for generating single-page html/latex.
  2. makedocs function allows passing of this ordering (as title => filename pairs). Warn/error if sections missing or do not exist in both src or yaml.

My preference is the mkdocs.yml as this already exists, and allows nested files etc.

This is crucial in compiling to a single document (e.g. #4).

@MichaelHatherly
Copy link
Member

I don't mine either option really. Go with the mkdocs.yml and we can see how it works out in practise.

@MichaelHatherly
Copy link
Member

Specifying page order was added in e7de659 (currently internal and undocumented since markdown output doesn't really need it). Closing this issue since #100 supersedes this I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants