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

Use mkdocs instead of default documentation #47

Open
kdheepak opened this issue Mar 14, 2019 · 3 comments
Open

Use mkdocs instead of default documentation #47

kdheepak opened this issue Mar 14, 2019 · 3 comments

Comments

@kdheepak
Copy link
Member

mkdocs supports more extensions and themes (See https://squidfunk.github.io/mkdocs-material/) and imho looks nicer. However, The default documentation allows looking at multiple versions using a drop down. With mkdocs we'll need to either add a separate markdown file with links to older versions or write some additional html / css / js to make that work. Any thoughts?

@tshort
Copy link
Collaborator

tshort commented Mar 14, 2019

I don't have an opinion here.

@PMeira
Copy link
Member

PMeira commented Feb 18, 2024

I might look into mkdocs as @kdheepak previously suggested, or even back to Sphinx if that gets a good overall integrated site down the line. We're adding more general docs, not specific to Julia. Sphinx-Julia is not archived yet, so it might work, otherwise even a custom script might generate better docs for the use case here.

With Documenter.jl, we can't even (easily) add links to the sidebar. There are many open issues in its repo with feature requests that might bear fruit someday, but since the documentation is one of the first impressions for new users, it might be better to use something without so many limitations in our context.

The Python packages were updated to use Markdown with MyST instead of reStructuredText, and I'm pretty happy with the results so far: https://dss-extensions.org/OpenDSSDirect.py/

@tshort
Copy link
Collaborator

tshort commented Feb 20, 2024

Franklin.jl is another option on the Julia side. I'm not sure it can crank out doc strings like Documenter, though.

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

3 participants