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

Documentation is not displayed well in roadie / github readme #157

Open
julesbertrand opened this issue Feb 27, 2024 · 0 comments
Open

Documentation is not displayed well in roadie / github readme #157

julesbertrand opened this issue Feb 27, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation Review effort [1-5]: 1

Comments

@julesbertrand
Copy link
Collaborator

🐛 Bug Report

Documentation is not displayed well in roadie / github readme.
Need to split between Pypi / Roadie / Github compatible and small readme, and mkdocs documentation

🔬 How To Reproduce

image

Code sample

Environment

  • OS: [e.g. Linux / Windows / macOS]
  • Python version, get it with:
python --version

Screenshots

📈 Expected behavior

📎 Additional context
@julesbertrand julesbertrand added bug Something isn't working documentation Improvements or additions to documentation Review effort [1-5]: 1 and removed bug Something isn't working labels Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation Review effort [1-5]: 1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@julesbertrand