Skip to content

Conversation

@Bibo-Joshi
Copy link
Member

@Bibo-Joshi Bibo-Joshi commented May 8, 2022

@Bibo-Joshi Bibo-Joshi added the ⚙️ documentation affected functionality: documentation label May 8, 2022
@Bibo-Joshi Bibo-Joshi added this to the v20.0a1 milestone May 8, 2022
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hey! Looks like you edited README.rst or README_RAW.rst. I'm just a friendly reminder to apply relevant changes to both of those files :)

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hey there. Relax, I am just a little warning for the maintainers to release directly after merging your PR, otherwise we have broken examples and people might get confused :)

Poolitzer and others added 5 commits May 14, 2022 13:57
# Conflicts:
#	README.rst
#	README_RAW.rst
#	docs/source/telegram.ext.rst
#	examples/README.md
#	telegram/_bot.py
#	telegram/ext/_jobqueue.py
@harshil21
Copy link
Member

I just noticed that after #3035, parameter referencing doesn't work for arguments under "Keyword Args:". Might be worth looking into later.

@Bibo-Joshi
Copy link
Member Author

Bibo-Joshi commented May 31, 2022

I just noticed that after #3035, parameter referencing doesn't work for arguments under "Keyword Args:". Might be worth looking into later.

Damn. But it appears to be rather easy to fix. From the docs, sphinx-doc/sphinx#2379 and sphinx-doc/sphinx#2381 it appears that the only difference is that instead of :param: and :type:, the roles :kwarg: and :kwtype: are used. Adding a new capturing group for that here and adjusting the functions cvt & secondary_cvt accordingly seems to do the trick in a first test. I'll try and PR for that upstream :)

edit: sqlalchemyorg/sphinx-paramlinks#16

Bibo-Joshi and others added 3 commits June 1, 2022 07:56
* Bump sphinx from 4.5.0 to 5.0.1

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 4.5.0 to 5.0.1.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/5.x/CHANGES)
- [Commits](sphinx-doc/sphinx@v4.5.0...v5.0.1)

---
updated-dependencies:
- dependency-name: sphinx
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump furo from 2022.04.07 to 2022.6.4 (#3081)

Bumps [furo](https://github.com/pradyunsg/furo) from 2022.04.07 to 2022.6.4.
- [Release notes](https://github.com/pradyunsg/furo/releases)
- [Changelog](https://github.com/pradyunsg/furo/blob/main/docs/changelog.md)
- [Commits](pradyunsg/furo@2022.04.07...2022.06.04)

---
updated-dependencies:
- dependency-name: furo
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* update docs conf

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>
# Conflicts:
#	examples/README.md
@Bibo-Joshi Bibo-Joshi merged commit 11007c1 into master Jun 9, 2022
@Bibo-Joshi Bibo-Joshi deleted the doc-fixes branch June 9, 2022 15:08
@github-actions github-actions bot locked and limited conversation to collaborators Jun 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

⚙️ documentation affected functionality: documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants