Upgraded the documentation #3
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
in /README.rst I added a longer introduction and the critical links. in /src/grokcore/startup/README.rst I fixed the setup.py instructions. And made a few other smaller edits.
Much better introduction and critical links. modified: setup.py So it refers to both README.rst rather than README.txt modified: src/grokcore/startup/README.rst So it gives a correct entry_points arguments.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Moved both README.txt files to README.rst
Made the required changes to setup.py
The documentation had a hugely wrong entrey_points=""" ..."""
Hopefully I got the new one right. I still have not got my upgrade working, so I am not quite sure. But it is clear that the existing version is wrong.
And of course I added links to all of the critical documentation.
Why am I doing this? Well I am just in the process of upgrading my applications from the old versions of grok represented in grokproject, to the new version in groktoolkit. I was quite stuck on getting paster to work. so I figured time to write the documentation. And indeed it helped. Specifically, the details in the Pyramid documentation I reference were most helpful.
Comments most appreciated, but it may take me a few days to process them. Tomorrow I head off to the French Picnic in Warsaw. France is Poland's 4th largest trading partner, and I speak French. Should be interesting, fun and tasty!