Skip to content

Fixed Edit on github links for v13.x documentation #3164

Merged
harshil21 merged 6 commits intopython-telegram-bot:doc-fixes-v13from
javad94:13.x-doc-fix
Aug 1, 2022
Merged

Fixed Edit on github links for v13.x documentation #3164
harshil21 merged 6 commits intopython-telegram-bot:doc-fixes-v13from
javad94:13.x-doc-fix

Conversation

@javad94
Copy link
Copy Markdown

@javad94 javad94 commented Jul 22, 2022

Checklist for PRs

  • Added .. versionadded:: version, .. versionchanged:: version or .. deprecated:: version to the docstrings for user facing changes (for methods/class descriptions, arguments and attributes)
  • Created new or adapted existing unit tests
  • Documented code changes according to the CSI standard
  • Added myself alphabetically to AUTHORS.rst (optional)
  • Added new classes & modules to the docs and all suitable __all__ s

@javad94
Copy link
Copy Markdown
Author

javad94 commented Jul 22, 2022

btw jinja2 gives ImportError when using sphinx-build docs/source docs/build/html command. Downgrading jinja2 from 3.1.2 to 3.0.3 fixed this issue. So should I update requirements-docs.txt too?

Traceback (most recent call last):
  File "C:\Users\Javad\Anaconda3\lib\runpy.py", line 197, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "C:\Users\Javad\Anaconda3\lib\runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File "D:\python-projects\ptb\venv\Scripts\sphinx-build.exe\__main__.py", line 4, in <module>
  File "D:\python-projects\ptb\venv\lib\site-packages\sphinx\cmd\build.py", line 25, in <module>
    from sphinx.application import Sphinx
  File "D:\python-projects\ptb\venv\lib\site-packages\sphinx\application.py", line 43, in <module>
    from sphinx.registry import SphinxComponentRegistry
  File "D:\python-projects\ptb\venv\lib\site-packages\sphinx\registry.py", line 24, in <module>
    from sphinx.builders import Builder
  File "D:\python-projects\ptb\venv\lib\site-packages\sphinx\builders\__init__.py", line 26, in <module>
    from sphinx.util import import_object, logging, progress_message, rst, status_iterator
  File "D:\python-projects\ptb\venv\lib\site-packages\sphinx\util\rst.py", line 21, in <module>
    from jinja2 import Environment, environmentfilter
ImportError: cannot import name 'environmentfilter' from 'jinja2' (D:\python-projects\ptb\venv\lib\site-packages\jinja2\__init__.py)

harshil21
harshil21 approved these changes Jul 23, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@harshil21 harshil21 left a comment

Choose a reason for hiding this comment

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

Thanks for the fix. Is your sphinx version the one specified in requirements-docs.txt? The error probably happens since the versions aren't exactly matching the ones we specified.

@javad94
Copy link
Copy Markdown
Author

javad94 commented Jul 23, 2022

Thanks for the fix. Is your sphinx version the one specified in requirements-docs.txt? The error probably happens since the versions aren't exactly matching the ones we specified.

Yes, it is the same version.
image

@harshil21
Copy link
Copy Markdown
Member

harshil21 commented Jul 23, 2022

okay since I see you're on a venv you probably have the right versions I'd say to go ahead and add that in (Jinja2 < 3.1). Makes sense you're getting this since I see this in the sphinx source code.

@javad94
Copy link
Copy Markdown
Author

javad94 commented Jul 23, 2022

okay since I see you're on a venv you probably have the right versions I'd say to go ahead and add that in (Jinja2 < 3.1). Makes sense you're getting this since I see this in the sphinx source code.

Of course, done.

harshil21
harshil21 reviewed Jul 23, 2022
View reviewed changes
@harshil21 harshil21 added the ⚙️ documentation affected functionality: documentation label Jul 23, 2022
@harshil21 harshil21 added this to the v13.14 milestone Jul 23, 2022
harshil21
harshil21 reviewed Jul 23, 2022
View reviewed changes
@javad94 @harshil21
Put comment link in newline
251f8cf 
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
@harshil21 harshil21 changed the base branch from v13.x to doc-fixes-v13 July 24, 2022 16:08
@javad94
Copy link
Copy Markdown
Author

javad94 commented Aug 1, 2022

@harshil21 Anything else needed to merge this PR?

@harshil21 harshil21 merged commit 864ee7a into python-telegram-bot:doc-fixes-v13 Aug 1, 2022
@harshil21
Copy link
Copy Markdown
Member

harshil21 commented Aug 1, 2022

Thanks for the contribution!

@javad94
Copy link
Copy Markdown
Author

javad94 commented Aug 1, 2022

Thanks for the contribution!

You're very welcome.

@Bibo-Joshi Bibo-Joshi mentioned this pull request Aug 1, 2022
Merged
2 tasks
@github-actions github-actions bot locked and limited conversation to collaborators Aug 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@harshil21 harshil21 harshil21 approved these changes

Assignees

No one assigned

Labels

⚙️ documentation affected functionality: documentation

Projects

None yet

Milestone

v13.14

Development

Successfully merging this pull request may close these issues.

3 participants

@javad94 @harshil21 @Bibo-Joshi