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

Make various documentation related updates. #1362

Merged
merged 10 commits into from
Jul 25, 2023
Merged

Conversation

waylan
Copy link
Member

@waylan waylan commented Jul 24, 2023

Document various policies which we have already been following:

  • Document release notes in Contributing Guide.
  • Add some additional notes regarding issues and PRs to contributing guide.
  • Comment on Commonmark on frontpage of docs (in Goals).

Also autolink to issues in release notes using mdx_gh_links.

Also abandoned the `doc-requirements.txt` file for a `docs` entry
in `pyproject.toml` under `[project.optional-dependencies]`. We are
now consistently defining optional dependencies project-wide. Note
that the dependencies can be installed with `pip install .[docs]`.
@waylan waylan added the process Discussions regarding policies and development process. label Jul 24, 2023
docs/contributing.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@waylan waylan merged commit d54b172 into Python-Markdown:master Jul 25, 2023
15 of 16 checks passed
@waylan waylan deleted the docs branch July 25, 2023 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
process Discussions regarding policies and development process.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants