Stuck on an issue?
Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Not clear that README.txt should contain a title
See original GitHub issueJust spent a while trying to reference the sphinx-gallery index page, and realised that my README.txt file only contained:
Examples
Changing this to
Examples
=======
made everything work as expected - it would be good mention in the docs that the README.txt file should have a title and is eventually interpreted as markup.
Issue Analytics
- State:
- Created 6 years ago
- Comments:5 (4 by maintainers)
Top Results From Across the Web
Warning in features_help() if README.txt was deleted or ...
In this issue, we will get rid of the warning if the README.txt is missing or not readable. In #1941894: Help is missing...
Read more >How to make a README.txt file
Provide a title for the dataset · Name/institution/address/email information for · Date of data collection (can be a single date, or a range)...
Read more >How to Write a Good README File for Your GitHub Project
In simple words, we can describe a README file as a guide that gives users a detailed description of a project you have...
Read more >README File – Everything you Need to Know - Great Learning
A README file is a text file that describes and launches a project. It comprises information that is frequently needed to grasp the...
Read more >Github readme.md showing plain code instead of title for url
in a file which is not a markdown (does not end with the .md extension), like a .txt file, which should not be...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
It would actually be ideal if the user could configure the name of this file in
conf.py. For example, repositories that usereadme.mdas a convention would rather follow that convention.Looking at https://sphinx-gallery.github.io/stable/getting_started.html#structure-the-examples-folder I think this is now fixed 🎉