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.

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

docs: refresh ZODB wiki tutorial #3751

Merged
merged 9 commits into from
Feb 8, 2024
Merged

Conversation

tseaver
Copy link
Member

@tseaver tseaver commented Feb 7, 2024

- Use 'pyproject.toml' rather than 'setup.py', 'pytest.ini', '.coveragerg'.
- Drop 'CHANGES.txt':  implementing that in 'pyproject.toml' is a
  distraction.
- Convert README to Markdown.
- Describe 'pyproject.toml' usage (replacing 'setup.py', 'pytest.ini',
  '.coveragerc').
- Document the new PyPA-blessed build process.
Copy link
Member

@mmerickel mmerickel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • I caught a missed reference to setup.py in the design chapter.
  • In definingviews I caught We need to add a dependency on the docutils package to our tutorial package's pyproject.toml file by assigning this dependency to the requires parameter in the setup() function. referencing the setup() function.
  • In tests chapter I caught several references to pytest.ini and .coveragerc. Might want to pull some of that language from here if it's helpful.
  • We had similar but different language around distributing your application. I think we should combine the good from both.

@mmerickel
Copy link
Member

mmerickel commented Feb 8, 2024

I pushed a version that merges things together for distributing.rst if you want to use it. https://raw.githubusercontent.com/Pylons/pyramid/b2c8840708079ad645cd7abea45634d4b8686eb8/docs/tutorials/wiki2/distributing.rst

@mmerickel
Copy link
Member

And tweaks to installation.rst for wiki2 here a31db99

@tseaver
Copy link
Member Author

tseaver commented Feb 8, 2024

@mmerickel I've cleaned up the remaining setup() / setup.py mentions, and folded in your language for Distrinbuting and Installation.

@mmerickel mmerickel merged commit 53eb7e7 into main Feb 8, 2024
28 checks passed
@mmerickel mmerickel deleted the tseaver-refresh-zodb-tutorial branch February 8, 2024 03:52
mmerickel added a commit that referenced this pull request Feb 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants