Closed NickleDave closed 6 years ago
Hi, Thanks for the PR - I've merged it. I agree that relying on line numbers in the README is a bit fragile. On the other hand, the README changes very very rarely, so I'm using your code 'as is' - if it causes issues in the future I can always amend it. Thanks again! Richard
Yay! Thank you for the chance to contribute, glad I could help
You're correct - the changes will appear in the next release. Which will happen in a few weeks, once I've checked compatibility of Photologue with the latest release of Django.
Hi @richardbarran I think this takes care of #188
You were right, there is a way to to get the text from
README.rst
intoindex.rst
--you can just a Sphinxinclude
directive. Notice that I used thestart-line
andend-line
options to skip the lines with a link to the docs (since the reader will already be at the docs page). That's kind of fragile if README.rst gets edited but I don't know of a better way to do it--there doesn't seem to be an "include sections" option. Also note I added=============
underContents:
because otherwise it looked kind of like the contents was just part of the previous section from the README.Using
include
looked like it worked when I ran make.bat with Sphinx locally and then viewed the html withhttp.server
, not sure if there's a better way to test.Let me know what you think!