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

Allow pages outside of packages #94

Closed
lpw25 opened this issue Nov 8, 2017 · 4 comments
Closed

Allow pages outside of packages #94

lpw25 opened this issue Nov 8, 2017 · 4 comments

Comments

@lpw25
Copy link
Contributor

lpw25 commented Nov 8, 2017

We should support something like:

odoc compile --at-root foo.mld

which does the same as:

odoc compile --package bar foo.mld

but places the pages at the root of the tree rather than in a package. This should produce an <root>/page-foo.odoc file which in turn become <root>/foo.html.

This should mostly just be a change to the "root" type in odoc making the package name optional, and using the appropriate URL for references to those roots.

@rizo
Copy link
Collaborator

rizo commented Oct 8, 2018

@lpw25 In your example what is <root> exactly? It's the path to the docset where all actual packages are located, right? Seems slightly related to #27.

I wasn't aware of this issue when I was working on #166. HTML fragments are an example of an output without a package, I had to use a dummy package name for that as a workaround.

@dbuenzli
Copy link
Contributor

dbuenzli commented Oct 8, 2018

This would certainly be useful for generating odig's index page, IIRC for now I have to make assumption for in the linking structure of odoc.

@lpw25
Copy link
Contributor Author

lpw25 commented Oct 8, 2018

It's the path to the docset where all actual packages are located, right?

That sounds right, yeah.

This would certainly be useful for generating odig's index page

IIRC that was indeed the kind of use case I had in mind when I opened this issue.

@github-actions
Copy link

github-actions bot commented May 1, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

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

5 participants