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 #474

Merged
merged 4 commits into from
Aug 11, 2022

Conversation

rahulporuri
Copy link
Contributor

This PR does the following:

  • Use the sphinx_copybutton extension when building the Sphinx documentation
  • Make sphinx-copybutton a docs extra for the envisage package
  • Add a pypi_dependencies section to the etstool utility and add sphinx-copybutton as a PyPI dependency for the moment.

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

Poruri Sai Rahul and others added 2 commits June 11, 2022 06:59
	modified:   docs/source/conf.py
	modified:   etstool.py
	modified:   setup.py
etstool.py Outdated
@@ -241,6 +244,14 @@ def install(edm, runtime, toolkit, environment, editable, source):
"{edm} run -e {environment} -- python -m pip install wxPython"
)

if pypi_dependencies:
Copy link
Member

Choose a reason for hiding this comment

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

This if seems redundant: if pypi_dependencies is empty, then no commands will be appended.

etstool.py Outdated Show resolved Hide resolved
Remove redundant if statement
setup.py Outdated Show resolved Hide resolved
Copy link
Member

@mdickinson mdickinson left a comment

Choose a reason for hiding this comment

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

LGTM; thanks for this!

@mdickinson mdickinson merged commit 7e93aa0 into main Aug 11, 2022
@mdickinson mdickinson deleted the docs/sphinx-copybutton branch August 11, 2022 16:11
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