-
Notifications
You must be signed in to change notification settings - Fork 622
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
Consider migrating docs from rst to mkdocs #2041
Comments
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
About this one, please do let me know if there's a timeline for this - I'd be happy to take this up accordingly. |
Thinking more, current docs just works. We may think to have a new shiny CSS layout. |
Ah, okay. Cool, this makes sense 👍 The search experience hasn't failed so far for anything I've wanted to look in the NF docs :) The only feedback I have is that, perhaps we should provide a visual marker (button/note) for the version, |
Rewriting the docs would require to much work and introduce errors. Better to look for a nicer HTML them for the current Sphynx generated docs |
The markdown format is more is easier to read and the Material for Mkdocs projects provide several non-intrusive extension for collapsible, tabs, callouts that make the result documentation much more readable.
To migrate rst format to markdown the following tools may help
The text was updated successfully, but these errors were encountered: