Move most README content to index.rst #656
Merged
Conversation
This file contains hidden or 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
bhrutledge
commented
Jun 8, 2020
| .. rtd-inclusion-marker-do-not-remove | ||
|
|
||
| Twine is `a utility`_ for `publishing`_ Python packages on `PyPI`_. | ||
| Twine is a utility for `publishing`_ Python packages on `PyPI`_. |
There was a problem hiding this comment.
The utility link went to PyPI, which seemed redundant with the badge above.
Comment on lines
-38
to
-40
| # HACK: Detect changes in README.rst; results in superfluous builds | ||
| # Mitigated somewhat by ignoring dotfiles | ||
| -z . -i '.*' \ |
There was a problem hiding this comment.
This was only necessary when docs/index.rst included README.rst.
sigmavirus24
reviewed
Jun 8, 2020
sigmavirus24
approved these changes
Jun 8, 2020
|
This looks good. Ideally the README is less overwhelming now and the docs serve their purpose better. |
|
Thanks, @sigmavirus24. In 172a828, I changed In f4a4cd6, I went a step further and shuffled some sections, prioritizing the command list above keyring, and pulling up "Configuration" in the outline. |
|
This all makes sense to me! Thanks again, @bhrutledge ! |
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.
Note: I know this unexpected, and normally I would open an issue first, but the change was easy enough to just do, and I thought might facilitate discussion.
I thought of this while working on #644. By putting all of the source for the documentation in one location, it makes it easier to build and preview. More importantly (I think), it gives a canonical destination for users and contributors. I also like the simplicity of the README for rendering on GitHub and PyPI.
README preview: https://github.com/bhrutledge/twine/blob/move-readme/README.rst
Docs preview: https://twine-docs.bhrutledge.now.sh/
Prior art:
Additional changes:
doc8lintingtox -e watch-docs