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

Provide Documenter.jl doc #93

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

s-celles
Copy link

@s-celles s-celles commented Dec 9, 2024

Helps #92

@s-celles
Copy link
Author

s-celles commented Dec 9, 2024

Documentation can be build locally like so:

cd docs
julia --project=. make.jl

It can be viewed statically browsing docs\build\index.html

or dynamically using LiveServer.jl like so

cd ..
julia -e 'using LiveServer; serve(host="127.0.0.1", port=8001, dir="docs/build")'

@s-celles
Copy link
Author

Hi @GunnarFarneback

Any news on this?

@GunnarFarneback
Copy link
Owner

Sorry, this lost attention to advent of code and was forgotten.

Anyway, I happen to like to have a self-sufficient README, so this would be more interesting if it could be done without breaking the README or duplicating information.

@s-celles
Copy link
Author

Hi @GunnarFarneback

README can be nearly empty but have a link to the doc.
I didn't did it in my PR but it can be done just after merging or in this PR if you prefer

Best regards

@GunnarFarneback
Copy link
Owner

That's the opposite of what I want.

@s-celles
Copy link
Author

s-celles commented Jan 21, 2025

I'm aware of this but a lot of Julia packages are doing this way.
An other solution could be to keep README nearly as it's. To add a link to the doc where advanced topics are exposed.
But it will be odd if we don't have basic usage in doc and only advanced usages.
Your code... your choices

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

Successfully merging this pull request may close these issues.

2 participants