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.

Sign up for GitHub

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

Jump to bottom

method: readme #116

Open
fredrikekre opened this issue Apr 28, 2020 · 5 comments
Open

method: readme #116

fredrikekre opened this issue Apr 28, 2020 · 5 comments
Labels
enhancement New feature or request

Comments

@fredrikekre
Copy link
Member

Some package use the readme as the full docs, would it make sense to support method = readme and not build docs (not even fallback docs) for those packages?
@pfitzseb
Copy link
Member

method = "none" might be the better name.
I'm not sure how valuable this would be, given that the fallback docs list docstrings etc.

@fredrikekre
Copy link
Member Author

For example https://juliahub.com/docs/jlpkg/aMH2o/1.1.3/ does not list anything extra compared to the rendered readme at https://juliahub.com/ui/Packages/jlpkg/aMH2o/1.1.3

@pfitzseb
Copy link
Member

There is https://juliahub.com/docs/jlpkg/aMH2o/1.1.3/autodocs/, but yeah, fair enough.

@fredrikekre
Copy link
Member Author

Yea but that is already in the README.

@fredrikekre
Copy link
Member Author

One option is to just use hosted and put the URL to the readme on GitHub.

@pfitzseb pfitzseb transferred this issue from JuliaDocs/DocumentationGeneratorRegistry Apr 28, 2020
@pfitzseb pfitzseb added the enhancement New feature or request label Apr 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pfitzseb @fredrikekre