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 setting path to entry point #581

Closed
matze opened this issue Aug 25, 2023 · 1 comment
Closed

Allow setting path to entry point #581

matze opened this issue Aug 25, 2023 · 1 comment

Comments

@matze
Copy link

matze commented Aug 25, 2023

Right now, the doc link only works if an index.html is present in the root of the uploaded zip file otherwise there will be a 404. However, there a few documentation generation systems that do not have an index.html in the root, for example cargo doc generates one per each crate including the dependency. It would be nice to specify the path to an entry point while uploading, for example in an HTTP header.

@fliiiix
Copy link
Member

fliiiix commented Aug 27, 2023

Thanks for reaching out and using docat 🎉

I took a look at the config and it seems there is a small bug.
#582

And there you have the option to override it to use a different index file.
But index.html is the de-facto standard for that usecase and we try to keep the options and configuration as limited as possible. For that reason i don't think we will ever add a option to configure a different entry point per project version.

You can use direct links even if you don't have a index.html like this

http://localhost:8000/#///foo.html

And for cargo specifically there are a few issues you can track where they want to add support for something like this
rust-lang/cargo#739

and in the meantime i would create a small shell script adding a index.html to your zip before uploading.

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

No branches or pull requests

2 participants