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

README rendering in html vs readthedocs #128

Open
Tracked by #146
wildsm opened this issue Aug 16, 2024 · 0 comments
Open
Tracked by #146

README rendering in html vs readthedocs #128

wildsm opened this issue Aug 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation pedantic

Comments

@wildsm
Copy link
Contributor

wildsm commented Aug 16, 2024

A minor nuisance is that the README.rst (e.g., https://github.com/bandframework/surmise/blob/main/README.rst) renders great in readthedocs but can look awkward in html.

An example is the rendering of the note call out under Installation, which currently renders in a browser as (in main, with updates changing the README but not the rendering issue):

Note

Direct installation of surmise requires

@wildsm wildsm added documentation Improvements or additions to documentation pendantic labels Aug 16, 2024
@wildsm wildsm mentioned this issue Aug 16, 2024
13 tasks
@wildsm wildsm added pedantic and removed pendantic labels Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pedantic
Projects
None yet
Development

No branches or pull requests

1 participant