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

Use the "sphinx-copybutton" extension in documentation #1134

Merged
merged 2 commits into from
Jun 29, 2022

Conversation

rahulporuri
Copy link
Contributor

This PR does the following:

  • Use the sphinx_copybutton extension when building the Sphinx documentation
  • Create a docs extra for the pyface package and add sphinx-copybutton as a docs dependency along with enthought-sphinx-theme and sphinx
  • Install sphinx-copybutton from PyPI when building docs using the etstool.py utility.

Ref https://sphinx-copybutton.readthedocs.io/en/latest/

	modified:   docs/source/conf.py
	modified:   etstool.py
	modified:   pyface/__init__.py
	modified:   doc-src-requirements.txt
	modified:   etstool.py
Copy link
Contributor

@corranwebster corranwebster left a comment

Choose a reason for hiding this comment

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

LGTM

@corranwebster corranwebster merged commit bd4a7bc into main Jun 29, 2022
@corranwebster corranwebster deleted the docs/sphinx-copybutton branch June 29, 2022 12:12
corranwebster pushed a commit that referenced this pull request Jun 29, 2022
* DOC: Use the sphinx-copybutton extension in documentation

	modified:   docs/source/conf.py
	modified:   etstool.py
	modified:   pyface/__init__.py

* CLN: Install sphinx-copybutton using doc-src-requirements file

	modified:   doc-src-requirements.txt
	modified:   etstool.py
corranwebster pushed a commit that referenced this pull request Jul 11, 2022
* DOC: Use the sphinx-copybutton extension in documentation

	modified:   docs/source/conf.py
	modified:   etstool.py
	modified:   pyface/__init__.py

* CLN: Install sphinx-copybutton using doc-src-requirements file

	modified:   doc-src-requirements.txt
	modified:   etstool.py
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.

2 participants