Install sphinx from docs/requirements.#436

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.

Sign up for GitHub

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

Merged
delucchi-cmu merged 2 commits into from
Feb 26, 2024
Merged

Install sphinx from docs/requirements. #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
080bc0e
Install sphinx from docs/requirements.
delucchi-cmu Feb 26, 2024
36ec415
Apply suggestions from code review
delucchi-cmu Feb 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@
# -- sphinx-copybutton configuration ----------------------------------------
## sets up the expected prompt text from console blocks, and excludes it from
## the text that goes into the clipboard.
copybutton_exclude = '.linenos, .gp'
copybutton_exclude = ".linenos, .gp"
copybutton_prompt_text = ">> "

## lets us suppress the copy button on select code blocks.
copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"

# -- Options for autosectionlabel -------------------------------------------------

autosectionlabel_prefix_document=True
autosectionlabel_prefix_document = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Expand Down
1 change: 1 addition & 0 deletions python-project-template/.initialize_new_project.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down
1 change: 1 addition & 0 deletions python-project-template/.setup_dev.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down
34 changes: 9 additions & 25 deletions python-project-template/pyproject.toml.jinja
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,9 +20,6 @@ classifiers = [
dynamic = ["version"]
requires-python = ">={{ python_versions[0] }}"
dependencies = [
{%- if include_notebooks %}
"ipykernel", # Support for Jupyter notebooks
{%- endif %}
]

[project.urls]
Expand All@@ -31,36 +28,23 @@ dependencies = [
# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
[project.optional-dependencies]
dev = [
"pytest",
"pytest-cov", # Used to report total code coverage
"pre-commit", # Used to run checks before finalizing a git commit
{%- if include_docs %}
"sphinx", # Used to automatically generate documentation
"sphinx-rtd-theme", # Used to render documentation
"sphinx-autoapi", # Used to automatically generate api documentation
{%- endif %}
{%- if 'pylint' in enforce_style %}
"pylint", # Used for static linting of files
{%- if include_benchmarks %}
"asv==0.6.1", # Used to compute performance benchmarks
{%- endif %}
{%- if 'black' in enforce_style %}
"black", # Used for static linting of files
{%- endif %}
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
"ruff", # Used for static linting of files
{%- endif %}
{%- if mypy_type_checking != 'none' %}
"mypy", # Used for static type checking of files
{%- endif %}
{%- if include_notebooks %}
# if you add dependencies here while experimenting in a notebook and you
# want that notebook to render in your documentation, please add the
# dependencies to ./docs/requirements.txt as well.
"nbconvert", # Needed for pre-commit check to clear output from Python notebooks
"nbsphinx", # Used to integrate Python notebooks into Sphinx documentation
"ipython", # Also used in building notebooks into Sphinx
"pre-commit", # Used to run checks before finalizing a git commit
{%- if 'pylint' in enforce_style %}
"pylint", # Used for static linting of files
{%- endif %}
{%- if include_benchmarks %}
"asv==0.6.1", # Used to compute performance benchmarks
"pytest",
"pytest-cov", # Used to report total code coverage
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
"ruff", # Used for static linting of files
{%- endif %}
]

Expand Down
14 changes: 8 additions & 6 deletions python-project-template/{% if include_docs %}docs{% endif %}/requirements.txt.jinja
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
sphinx
sphinx-rtd-theme
sphinx-autoapi
sphinx-copybutton
{%- if include_notebooks %}
nbsphinx
ipykernel
ipython
jupytext
jupyter
jupytext
nbconvert
nbsphinx
{%- endif %}
sphinx
sphinx-autoapi
sphinx-copybutton
sphinx-rtd-theme
60 changes: 45 additions & 15 deletions tests/test_package_creation.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,26 @@ def successfully_created_project(result):
return result.exit_code == 0 and result.exception is None and result.project_dir.is_dir()


def contains_required_files(result):
required_files = [
".copier-answers.yml",
".git_archival.txt",
".gitattributes",
".gitignore",
".pre-commit-config.yaml",
".setup_dev.sh",
"LICENSE",
"pyproject.toml",
"README.md",
]
all_found = True
for file in required_files:
if not (result.project_dir / file).is_file():
all_found = False
print("Required file not generated:", file)
return all_found


def directory_structure_is_correct(result, package_name="example_package"):
"""Test to ensure that the default directory structure ws created correctly"""
return (result.project_dir / f"src/{package_name}").is_dir() and (
Expand DownExpand Up@@ -65,14 +85,24 @@ def docs_build_successfully(result):
virtual environment for the project.
"""

sphinx_results = subprocess.run(
["make", "html"],
cwd=(result.project_dir / "docs"),
)
required_files = [
".readthedocs.yml",
]
all_found = True
for file in required_files:
if not (result.project_dir / file).is_file():
all_found = False
print("Required file not generated:", file)
return all_found

# sphinx_results = subprocess.run(
# ["make", "html"],
# cwd=(result.project_dir / "docs"),
# )

# return sphinx_results.returncode == 0

return sphinx_results.returncode == 0


def github_workflows_are_valid(result):
"""Test to ensure that the GitHub workflows are valid"""
workflows_results = subprocess.run(
Expand All@@ -95,14 +125,9 @@ def test_all_defaults(copie):
result = copie.copy()

assert successfully_created_project(result)

assert directory_structure_is_correct(result)

assert not pylint_runs_successfully(result)

# make sure that some basic files were created
assert (result.project_dir / "README.md").is_file()
assert (result.project_dir / "pyproject.toml").is_file()
assert contains_required_files(result)

# check to see if the README file was hydrated with copier answers.
found_line = False
Expand DownExpand Up@@ -130,10 +155,9 @@ def test_use_black_and_no_example_modules(copie):
result = copie.copy(extra_answers=extra_answers)

assert successfully_created_project(result)

assert directory_structure_is_correct(result)

assert pylint_runs_successfully(result)
assert contains_required_files(result)

# make sure that the files that were not requested were not created
assert not (result.project_dir / "src/example_package/example_module.py").is_file()
Expand DownExpand Up@@ -174,6 +198,7 @@ def test_code_style_combinations(copie, enforce_style):
result = copie.copy(extra_answers=extra_answers)
assert successfully_created_project(result)
assert directory_structure_is_correct(result)
assert contains_required_files(result)
# black would still run successfully.
assert black_runs_successfully(result)

Expand DownExpand Up@@ -202,6 +227,7 @@ def test_smoke_test_notification(copie, notification):
assert successfully_created_project(result)
assert directory_structure_is_correct(result)
assert black_runs_successfully(result)
assert contains_required_files(result)


@pytest.mark.parametrize(
Expand All@@ -226,6 +252,8 @@ def test_doc_combinations(copie, doc_answers):
assert successfully_created_project(result)
assert directory_structure_is_correct(result)
assert black_runs_successfully(result)
assert contains_required_files(result)
assert docs_build_successfully(result)
assert (result.project_dir / "docs").is_dir()


Expand All@@ -251,9 +279,10 @@ def test_doc_combinations_no_docs(copie, doc_answers):
assert successfully_created_project(result)
assert directory_structure_is_correct(result)
assert black_runs_successfully(result)
assert contains_required_files(result)
assert not (result.project_dir / "docs").is_dir()


def test_github_workflows_schema(copie):
"""Confirm the current GitHub workflows have valid schemas."""
extra_answers = {
Expand All@@ -263,3 +292,4 @@ def test_github_workflows_schema(copie):
result = copie.copy(extra_answers=extra_answers)
initialize_git_project(result)
assert github_workflows_are_valid(result)
assert contains_required_files(result)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Install sphinx from docs/requirements.#436

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.

 Sign up for GitHub

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

 Merged

delucchi-cmu
merged 2 commits into

from

Feb 26, 2024
 Merged


Install sphinx from docs/requirements.
#436
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
080bc0e

Install sphinx from docs/requirements.


delucchi-cmu Feb 26, 2024
36ec415

Apply suggestions from code review


delucchi-cmu Feb 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@
# -- sphinx-copybutton configuration ----------------------------------------
## sets up the expected prompt text from console blocks, and excludes it from
## the text that goes into the clipboard.
copybutton_exclude = '.linenos, .gp'
copybutton_exclude = ".linenos, .gp"
copybutton_prompt_text = ">> "

## lets us suppress the copy button on select code blocks.
copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"

# -- Options for autosectionlabel -------------------------------------------------

autosectionlabel_prefix_document=True
autosectionlabel_prefix_document = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.initialize_new_project.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.setup_dev.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

34 changes: 9 additions & 25 deletions
python-project-template/pyproject.toml.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,9 +20,6 @@ classifiers = [
dynamic = ["version"]
requires-python = ">={{ python_versions[0] }}"
dependencies = [
{%- if include_notebooks %}
 "ipykernel", # Support for Jupyter notebooks
{%- endif %}
]

[project.urls]
Expand All@@ -31,36 +28,23 @@ dependencies = [
# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
[project.optional-dependencies]
dev = [
 "pytest",
 "pytest-cov", # Used to report total code coverage
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if include_docs %}
 "sphinx", # Used to automatically generate documentation
 "sphinx-rtd-theme", # Used to render documentation
 "sphinx-autoapi", # Used to automatically generate api documentation
{%- endif %}
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
{%- endif %}
{%- if 'black' in enforce_style %}
 "black", # Used for static linting of files
{%- endif %}
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
{%- if mypy_type_checking != 'none' %}
 "mypy", # Used for static type checking of files
{%- endif %}
{%- if include_notebooks %}
 # if you add dependencies here while experimenting in a notebook and you
 # want that notebook to render in your documentation, please add the
 # dependencies to ./docs/requirements.txt as well.
 "nbconvert", # Needed for pre-commit check to clear output from Python notebooks
 "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation
 "ipython", # Also used in building notebooks into Sphinx
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- endif %}
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
 "pytest",
 "pytest-cov", # Used to report total code coverage
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
]

Expand Down

14 changes: 8 additions & 6 deletions
python-project-template/{% if include_docs %}docs{% endif %}/requirements.txt.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
sphinx
sphinx-rtd-theme
sphinx-autoapi
sphinx-copybutton
{%- if include_notebooks %}
nbsphinx
ipykernel
ipython
jupytext
jupyter
jupytext
nbconvert
nbsphinx
{%- endif %}
sphinx
sphinx-autoapi
sphinx-copybutton
sphinx-rtd-theme

60 changes: 45 additions & 15 deletions
tests/test_package_creation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,26 @@ def successfully_created_project(result):
 return result.exit_code == 0 and result.exception is None and result.project_dir.is_dir()


def contains_required_files(result):
 required_files = [
 ".copier-answers.yml",
 ".git_archival.txt",
 ".gitattributes",
 ".gitignore",
 ".pre-commit-config.yaml",
 ".setup_dev.sh",
 "LICENSE",
 "pyproject.toml",
 "README.md",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found


def directory_structure_is_correct(result, package_name="example_package"):
 """Test to ensure that the default directory structure ws created correctly"""
 return (result.project_dir / f"src/{package_name}").is_dir() and (
Expand DownExpand Up@@ -65,14 +85,24 @@ def docs_build_successfully(result):
 virtual environment for the project.
 """

 sphinx_results = subprocess.run(
 ["make", "html"],
 cwd=(result.project_dir / "docs"),
 )
 required_files = [
 ".readthedocs.yml",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found

 # sphinx_results = subprocess.run(
 # ["make", "html"],
 # cwd=(result.project_dir / "docs"),
 # )

 # return sphinx_results.returncode == 0

 return sphinx_results.returncode == 0


def github_workflows_are_valid(result):
 """Test to ensure that the GitHub workflows are valid"""
 workflows_results = subprocess.run(
Expand All@@ -95,14 +125,9 @@ def test_all_defaults(copie):
 result = copie.copy()

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert not pylint_runs_successfully(result)

 # make sure that some basic files were created
 assert (result.project_dir / "README.md").is_file()
 assert (result.project_dir / "pyproject.toml").is_file()
 assert contains_required_files(result)

 # check to see if the README file was hydrated with copier answers.
 found_line = False
Expand DownExpand Up@@ -130,10 +155,9 @@ def test_use_black_and_no_example_modules(copie):
 result = copie.copy(extra_answers=extra_answers)

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert pylint_runs_successfully(result)
 assert contains_required_files(result)

 # make sure that the files that were not requested were not created
 assert not (result.project_dir / "src/example_package/example_module.py").is_file()
Expand DownExpand Up@@ -174,6 +198,7 @@ def test_code_style_combinations(copie, enforce_style):
 result = copie.copy(extra_answers=extra_answers)
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert contains_required_files(result)
 # black would still run successfully.
 assert black_runs_successfully(result)

Expand DownExpand Up@@ -202,6 +227,7 @@ def test_smoke_test_notification(copie, notification):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)


@pytest.mark.parametrize(
Expand All@@ -226,6 +252,8 @@ def test_doc_combinations(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert docs_build_successfully(result)
 assert (result.project_dir / "docs").is_dir()


Expand All@@ -251,9 +279,10 @@ def test_doc_combinations_no_docs(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert not (result.project_dir / "docs").is_dir()


def test_github_workflows_schema(copie):
 """Confirm the current GitHub workflows have valid schemas."""
 extra_answers = {
Expand All@@ -263,3 +292,4 @@ def test_github_workflows_schema(copie):
 result = copie.copy(extra_answers=extra_answers)
 initialize_git_project(result)
 assert github_workflows_are_valid(result)
 assert contains_required_files(result)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Install sphinx from docs/requirements.#436

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.

 Sign up for GitHub

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

 Merged

delucchi-cmu
merged 2 commits into

from

Feb 26, 2024
 Merged


Install sphinx from docs/requirements.
#436
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
080bc0e

Install sphinx from docs/requirements.


delucchi-cmu Feb 26, 2024
36ec415

Apply suggestions from code review


delucchi-cmu Feb 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@
# -- sphinx-copybutton configuration ----------------------------------------
## sets up the expected prompt text from console blocks, and excludes it from
## the text that goes into the clipboard.
copybutton_exclude = '.linenos, .gp'
copybutton_exclude = ".linenos, .gp"
copybutton_prompt_text = ">> "

## lets us suppress the copy button on select code blocks.
copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"

# -- Options for autosectionlabel -------------------------------------------------

autosectionlabel_prefix_document=True
autosectionlabel_prefix_document = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.initialize_new_project.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.setup_dev.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

34 changes: 9 additions & 25 deletions
python-project-template/pyproject.toml.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,9 +20,6 @@ classifiers = [
dynamic = ["version"]
requires-python = ">={{ python_versions[0] }}"
dependencies = [
{%- if include_notebooks %}
 "ipykernel", # Support for Jupyter notebooks
{%- endif %}
]

[project.urls]
Expand All@@ -31,36 +28,23 @@ dependencies = [
# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
[project.optional-dependencies]
dev = [
 "pytest",
 "pytest-cov", # Used to report total code coverage
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if include_docs %}
 "sphinx", # Used to automatically generate documentation
 "sphinx-rtd-theme", # Used to render documentation
 "sphinx-autoapi", # Used to automatically generate api documentation
{%- endif %}
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
{%- endif %}
{%- if 'black' in enforce_style %}
 "black", # Used for static linting of files
{%- endif %}
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
{%- if mypy_type_checking != 'none' %}
 "mypy", # Used for static type checking of files
{%- endif %}
{%- if include_notebooks %}
 # if you add dependencies here while experimenting in a notebook and you
 # want that notebook to render in your documentation, please add the
 # dependencies to ./docs/requirements.txt as well.
 "nbconvert", # Needed for pre-commit check to clear output from Python notebooks
 "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation
 "ipython", # Also used in building notebooks into Sphinx
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- endif %}
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
 "pytest",
 "pytest-cov", # Used to report total code coverage
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
]

Expand Down

14 changes: 8 additions & 6 deletions
python-project-template/{% if include_docs %}docs{% endif %}/requirements.txt.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
sphinx
sphinx-rtd-theme
sphinx-autoapi
sphinx-copybutton
{%- if include_notebooks %}
nbsphinx
ipykernel
ipython
jupytext
jupyter
jupytext
nbconvert
nbsphinx
{%- endif %}
sphinx
sphinx-autoapi
sphinx-copybutton
sphinx-rtd-theme

60 changes: 45 additions & 15 deletions
tests/test_package_creation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,26 @@ def successfully_created_project(result):
 return result.exit_code == 0 and result.exception is None and result.project_dir.is_dir()


def contains_required_files(result):
 required_files = [
 ".copier-answers.yml",
 ".git_archival.txt",
 ".gitattributes",
 ".gitignore",
 ".pre-commit-config.yaml",
 ".setup_dev.sh",
 "LICENSE",
 "pyproject.toml",
 "README.md",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found


def directory_structure_is_correct(result, package_name="example_package"):
 """Test to ensure that the default directory structure ws created correctly"""
 return (result.project_dir / f"src/{package_name}").is_dir() and (
Expand DownExpand Up@@ -65,14 +85,24 @@ def docs_build_successfully(result):
 virtual environment for the project.
 """

 sphinx_results = subprocess.run(
 ["make", "html"],
 cwd=(result.project_dir / "docs"),
 )
 required_files = [
 ".readthedocs.yml",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found

 # sphinx_results = subprocess.run(
 # ["make", "html"],
 # cwd=(result.project_dir / "docs"),
 # )

 # return sphinx_results.returncode == 0

 return sphinx_results.returncode == 0


def github_workflows_are_valid(result):
 """Test to ensure that the GitHub workflows are valid"""
 workflows_results = subprocess.run(
Expand All@@ -95,14 +125,9 @@ def test_all_defaults(copie):
 result = copie.copy()

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert not pylint_runs_successfully(result)

 # make sure that some basic files were created
 assert (result.project_dir / "README.md").is_file()
 assert (result.project_dir / "pyproject.toml").is_file()
 assert contains_required_files(result)

 # check to see if the README file was hydrated with copier answers.
 found_line = False
Expand DownExpand Up@@ -130,10 +155,9 @@ def test_use_black_and_no_example_modules(copie):
 result = copie.copy(extra_answers=extra_answers)

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert pylint_runs_successfully(result)
 assert contains_required_files(result)

 # make sure that the files that were not requested were not created
 assert not (result.project_dir / "src/example_package/example_module.py").is_file()
Expand DownExpand Up@@ -174,6 +198,7 @@ def test_code_style_combinations(copie, enforce_style):
 result = copie.copy(extra_answers=extra_answers)
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert contains_required_files(result)
 # black would still run successfully.
 assert black_runs_successfully(result)

Expand DownExpand Up@@ -202,6 +227,7 @@ def test_smoke_test_notification(copie, notification):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)


@pytest.mark.parametrize(
Expand All@@ -226,6 +252,8 @@ def test_doc_combinations(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert docs_build_successfully(result)
 assert (result.project_dir / "docs").is_dir()


Expand All@@ -251,9 +279,10 @@ def test_doc_combinations_no_docs(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert not (result.project_dir / "docs").is_dir()


def test_github_workflows_schema(copie):
 """Confirm the current GitHub workflows have valid schemas."""
 extra_answers = {
Expand All@@ -263,3 +292,4 @@ def test_github_workflows_schema(copie):
 result = copie.copy(extra_answers=extra_answers)
 initialize_git_project(result)
 assert github_workflows_are_valid(result)
 assert contains_required_files(result)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Install sphinx from docs/requirements.#436

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.

 Sign up for GitHub

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

 Merged

delucchi-cmu
merged 2 commits into

from

Feb 26, 2024
 Merged


Install sphinx from docs/requirements.
#436
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
080bc0e

Install sphinx from docs/requirements.


delucchi-cmu Feb 26, 2024
36ec415

Apply suggestions from code review


delucchi-cmu Feb 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@
# -- sphinx-copybutton configuration ----------------------------------------
## sets up the expected prompt text from console blocks, and excludes it from
## the text that goes into the clipboard.
copybutton_exclude = '.linenos, .gp'
copybutton_exclude = ".linenos, .gp"
copybutton_prompt_text = ">> "

## lets us suppress the copy button on select code blocks.
copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"

# -- Options for autosectionlabel -------------------------------------------------

autosectionlabel_prefix_document=True
autosectionlabel_prefix_document = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.initialize_new_project.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.setup_dev.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

34 changes: 9 additions & 25 deletions
python-project-template/pyproject.toml.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,9 +20,6 @@ classifiers = [
dynamic = ["version"]
requires-python = ">={{ python_versions[0] }}"
dependencies = [
{%- if include_notebooks %}
 "ipykernel", # Support for Jupyter notebooks
{%- endif %}
]

[project.urls]
Expand All@@ -31,36 +28,23 @@ dependencies = [
# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
[project.optional-dependencies]
dev = [
 "pytest",
 "pytest-cov", # Used to report total code coverage
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if include_docs %}
 "sphinx", # Used to automatically generate documentation
 "sphinx-rtd-theme", # Used to render documentation
 "sphinx-autoapi", # Used to automatically generate api documentation
{%- endif %}
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
{%- endif %}
{%- if 'black' in enforce_style %}
 "black", # Used for static linting of files
{%- endif %}
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
{%- if mypy_type_checking != 'none' %}
 "mypy", # Used for static type checking of files
{%- endif %}
{%- if include_notebooks %}
 # if you add dependencies here while experimenting in a notebook and you
 # want that notebook to render in your documentation, please add the
 # dependencies to ./docs/requirements.txt as well.
 "nbconvert", # Needed for pre-commit check to clear output from Python notebooks
 "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation
 "ipython", # Also used in building notebooks into Sphinx
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- endif %}
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
 "pytest",
 "pytest-cov", # Used to report total code coverage
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
]

Expand Down

14 changes: 8 additions & 6 deletions
python-project-template/{% if include_docs %}docs{% endif %}/requirements.txt.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
sphinx
sphinx-rtd-theme
sphinx-autoapi
sphinx-copybutton
{%- if include_notebooks %}
nbsphinx
ipykernel
ipython
jupytext
jupyter
jupytext
nbconvert
nbsphinx
{%- endif %}
sphinx
sphinx-autoapi
sphinx-copybutton
sphinx-rtd-theme

60 changes: 45 additions & 15 deletions
tests/test_package_creation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,26 @@ def successfully_created_project(result):
 return result.exit_code == 0 and result.exception is None and result.project_dir.is_dir()


def contains_required_files(result):
 required_files = [
 ".copier-answers.yml",
 ".git_archival.txt",
 ".gitattributes",
 ".gitignore",
 ".pre-commit-config.yaml",
 ".setup_dev.sh",
 "LICENSE",
 "pyproject.toml",
 "README.md",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found


def directory_structure_is_correct(result, package_name="example_package"):
 """Test to ensure that the default directory structure ws created correctly"""
 return (result.project_dir / f"src/{package_name}").is_dir() and (
Expand DownExpand Up@@ -65,14 +85,24 @@ def docs_build_successfully(result):
 virtual environment for the project.
 """

 sphinx_results = subprocess.run(
 ["make", "html"],
 cwd=(result.project_dir / "docs"),
 )
 required_files = [
 ".readthedocs.yml",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found

 # sphinx_results = subprocess.run(
 # ["make", "html"],
 # cwd=(result.project_dir / "docs"),
 # )

 # return sphinx_results.returncode == 0

 return sphinx_results.returncode == 0


def github_workflows_are_valid(result):
 """Test to ensure that the GitHub workflows are valid"""
 workflows_results = subprocess.run(
Expand All@@ -95,14 +125,9 @@ def test_all_defaults(copie):
 result = copie.copy()

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert not pylint_runs_successfully(result)

 # make sure that some basic files were created
 assert (result.project_dir / "README.md").is_file()
 assert (result.project_dir / "pyproject.toml").is_file()
 assert contains_required_files(result)

 # check to see if the README file was hydrated with copier answers.
 found_line = False
Expand DownExpand Up@@ -130,10 +155,9 @@ def test_use_black_and_no_example_modules(copie):
 result = copie.copy(extra_answers=extra_answers)

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert pylint_runs_successfully(result)
 assert contains_required_files(result)

 # make sure that the files that were not requested were not created
 assert not (result.project_dir / "src/example_package/example_module.py").is_file()
Expand DownExpand Up@@ -174,6 +198,7 @@ def test_code_style_combinations(copie, enforce_style):
 result = copie.copy(extra_answers=extra_answers)
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert contains_required_files(result)
 # black would still run successfully.
 assert black_runs_successfully(result)

Expand DownExpand Up@@ -202,6 +227,7 @@ def test_smoke_test_notification(copie, notification):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)


@pytest.mark.parametrize(
Expand All@@ -226,6 +252,8 @@ def test_doc_combinations(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert docs_build_successfully(result)
 assert (result.project_dir / "docs").is_dir()


Expand All@@ -251,9 +279,10 @@ def test_doc_combinations_no_docs(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert not (result.project_dir / "docs").is_dir()


def test_github_workflows_schema(copie):
 """Confirm the current GitHub workflows have valid schemas."""
 extra_answers = {
Expand All@@ -263,3 +292,4 @@ def test_github_workflows_schema(copie):
 result = copie.copy(extra_answers=extra_answers)
 initialize_git_project(result)
 assert github_workflows_are_valid(result)
 assert contains_required_files(result)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Install sphinx from docs/requirements.#436

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.

 Sign up for GitHub

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

 Merged

delucchi-cmu
merged 2 commits into

from

Feb 26, 2024
 Merged


Install sphinx from docs/requirements.
#436
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
080bc0e

Install sphinx from docs/requirements.


delucchi-cmu Feb 26, 2024
36ec415

Apply suggestions from code review


delucchi-cmu Feb 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@
# -- sphinx-copybutton configuration ----------------------------------------
## sets up the expected prompt text from console blocks, and excludes it from
## the text that goes into the clipboard.
copybutton_exclude = '.linenos, .gp'
copybutton_exclude = ".linenos, .gp"
copybutton_prompt_text = ">> "

## lets us suppress the copy button on select code blocks.
copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"

# -- Options for autosectionlabel -------------------------------------------------

autosectionlabel_prefix_document=True
autosectionlabel_prefix_document = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.initialize_new_project.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.setup_dev.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

34 changes: 9 additions & 25 deletions
python-project-template/pyproject.toml.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,9 +20,6 @@ classifiers = [
dynamic = ["version"]
requires-python = ">={{ python_versions[0] }}"
dependencies = [
{%- if include_notebooks %}
 "ipykernel", # Support for Jupyter notebooks
{%- endif %}
]

[project.urls]
Expand All@@ -31,36 +28,23 @@ dependencies = [
# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
[project.optional-dependencies]
dev = [
 "pytest",
 "pytest-cov", # Used to report total code coverage
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if include_docs %}
 "sphinx", # Used to automatically generate documentation
 "sphinx-rtd-theme", # Used to render documentation
 "sphinx-autoapi", # Used to automatically generate api documentation
{%- endif %}
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
{%- endif %}
{%- if 'black' in enforce_style %}
 "black", # Used for static linting of files
{%- endif %}
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
{%- if mypy_type_checking != 'none' %}
 "mypy", # Used for static type checking of files
{%- endif %}
{%- if include_notebooks %}
 # if you add dependencies here while experimenting in a notebook and you
 # want that notebook to render in your documentation, please add the
 # dependencies to ./docs/requirements.txt as well.
 "nbconvert", # Needed for pre-commit check to clear output from Python notebooks
 "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation
 "ipython", # Also used in building notebooks into Sphinx
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- endif %}
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
 "pytest",
 "pytest-cov", # Used to report total code coverage
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
]

Expand Down

14 changes: 8 additions & 6 deletions
python-project-template/{% if include_docs %}docs{% endif %}/requirements.txt.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
sphinx
sphinx-rtd-theme
sphinx-autoapi
sphinx-copybutton
{%- if include_notebooks %}
nbsphinx
ipykernel
ipython
jupytext
jupyter
jupytext
nbconvert
nbsphinx
{%- endif %}
sphinx
sphinx-autoapi
sphinx-copybutton
sphinx-rtd-theme

60 changes: 45 additions & 15 deletions
tests/test_package_creation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,26 @@ def successfully_created_project(result):
 return result.exit_code == 0 and result.exception is None and result.project_dir.is_dir()


def contains_required_files(result):
 required_files = [
 ".copier-answers.yml",
 ".git_archival.txt",
 ".gitattributes",
 ".gitignore",
 ".pre-commit-config.yaml",
 ".setup_dev.sh",
 "LICENSE",
 "pyproject.toml",
 "README.md",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found


def directory_structure_is_correct(result, package_name="example_package"):
 """Test to ensure that the default directory structure ws created correctly"""
 return (result.project_dir / f"src/{package_name}").is_dir() and (
Expand DownExpand Up@@ -65,14 +85,24 @@ def docs_build_successfully(result):
 virtual environment for the project.
 """

 sphinx_results = subprocess.run(
 ["make", "html"],
 cwd=(result.project_dir / "docs"),
 )
 required_files = [
 ".readthedocs.yml",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found

 # sphinx_results = subprocess.run(
 # ["make", "html"],
 # cwd=(result.project_dir / "docs"),
 # )

 # return sphinx_results.returncode == 0

 return sphinx_results.returncode == 0


def github_workflows_are_valid(result):
 """Test to ensure that the GitHub workflows are valid"""
 workflows_results = subprocess.run(
Expand All@@ -95,14 +125,9 @@ def test_all_defaults(copie):
 result = copie.copy()

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert not pylint_runs_successfully(result)

 # make sure that some basic files were created
 assert (result.project_dir / "README.md").is_file()
 assert (result.project_dir / "pyproject.toml").is_file()
 assert contains_required_files(result)

 # check to see if the README file was hydrated with copier answers.
 found_line = False
Expand DownExpand Up@@ -130,10 +155,9 @@ def test_use_black_and_no_example_modules(copie):
 result = copie.copy(extra_answers=extra_answers)

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert pylint_runs_successfully(result)
 assert contains_required_files(result)

 # make sure that the files that were not requested were not created
 assert not (result.project_dir / "src/example_package/example_module.py").is_file()
Expand DownExpand Up@@ -174,6 +198,7 @@ def test_code_style_combinations(copie, enforce_style):
 result = copie.copy(extra_answers=extra_answers)
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert contains_required_files(result)
 # black would still run successfully.
 assert black_runs_successfully(result)

Expand DownExpand Up@@ -202,6 +227,7 @@ def test_smoke_test_notification(copie, notification):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)


@pytest.mark.parametrize(
Expand All@@ -226,6 +252,8 @@ def test_doc_combinations(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert docs_build_successfully(result)
 assert (result.project_dir / "docs").is_dir()


Expand All@@ -251,9 +279,10 @@ def test_doc_combinations_no_docs(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert not (result.project_dir / "docs").is_dir()


def test_github_workflows_schema(copie):
 """Confirm the current GitHub workflows have valid schemas."""
 extra_answers = {
Expand All@@ -263,3 +292,4 @@ def test_github_workflows_schema(copie):
 result = copie.copy(extra_answers=extra_answers)
 initialize_git_project(result)
 assert github_workflows_are_valid(result)
 assert contains_required_files(result)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Install sphinx from docs/requirements.#436

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.

 Sign up for GitHub

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

 Merged

delucchi-cmu
merged 2 commits into

from

Feb 26, 2024
 Merged


Install sphinx from docs/requirements.
#436
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
080bc0e

Install sphinx from docs/requirements.


delucchi-cmu Feb 26, 2024
36ec415

Apply suggestions from code review


delucchi-cmu Feb 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@
# -- sphinx-copybutton configuration ----------------------------------------
## sets up the expected prompt text from console blocks, and excludes it from
## the text that goes into the clipboard.
copybutton_exclude = '.linenos, .gp'
copybutton_exclude = ".linenos, .gp"
copybutton_prompt_text = ">> "

## lets us suppress the copy button on select code blocks.
copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"

# -- Options for autosectionlabel -------------------------------------------------

autosectionlabel_prefix_document=True
autosectionlabel_prefix_document = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.initialize_new_project.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.setup_dev.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

34 changes: 9 additions & 25 deletions
python-project-template/pyproject.toml.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,9 +20,6 @@ classifiers = [
dynamic = ["version"]
requires-python = ">={{ python_versions[0] }}"
dependencies = [
{%- if include_notebooks %}
 "ipykernel", # Support for Jupyter notebooks
{%- endif %}
]

[project.urls]
Expand All@@ -31,36 +28,23 @@ dependencies = [
# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
[project.optional-dependencies]
dev = [
 "pytest",
 "pytest-cov", # Used to report total code coverage
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if include_docs %}
 "sphinx", # Used to automatically generate documentation
 "sphinx-rtd-theme", # Used to render documentation
 "sphinx-autoapi", # Used to automatically generate api documentation
{%- endif %}
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
{%- endif %}
{%- if 'black' in enforce_style %}
 "black", # Used for static linting of files
{%- endif %}
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
{%- if mypy_type_checking != 'none' %}
 "mypy", # Used for static type checking of files
{%- endif %}
{%- if include_notebooks %}
 # if you add dependencies here while experimenting in a notebook and you
 # want that notebook to render in your documentation, please add the
 # dependencies to ./docs/requirements.txt as well.
 "nbconvert", # Needed for pre-commit check to clear output from Python notebooks
 "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation
 "ipython", # Also used in building notebooks into Sphinx
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- endif %}
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
 "pytest",
 "pytest-cov", # Used to report total code coverage
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
]

Expand Down

14 changes: 8 additions & 6 deletions
python-project-template/{% if include_docs %}docs{% endif %}/requirements.txt.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
sphinx
sphinx-rtd-theme
sphinx-autoapi
sphinx-copybutton
{%- if include_notebooks %}
nbsphinx
ipykernel
ipython
jupytext
jupyter
jupytext
nbconvert
nbsphinx
{%- endif %}
sphinx
sphinx-autoapi
sphinx-copybutton
sphinx-rtd-theme

60 changes: 45 additions & 15 deletions
tests/test_package_creation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,26 @@ def successfully_created_project(result):
 return result.exit_code == 0 and result.exception is None and result.project_dir.is_dir()


def contains_required_files(result):
 required_files = [
 ".copier-answers.yml",
 ".git_archival.txt",
 ".gitattributes",
 ".gitignore",
 ".pre-commit-config.yaml",
 ".setup_dev.sh",
 "LICENSE",
 "pyproject.toml",
 "README.md",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found


def directory_structure_is_correct(result, package_name="example_package"):
 """Test to ensure that the default directory structure ws created correctly"""
 return (result.project_dir / f"src/{package_name}").is_dir() and (
Expand DownExpand Up@@ -65,14 +85,24 @@ def docs_build_successfully(result):
 virtual environment for the project.
 """

 sphinx_results = subprocess.run(
 ["make", "html"],
 cwd=(result.project_dir / "docs"),
 )
 required_files = [
 ".readthedocs.yml",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found

 # sphinx_results = subprocess.run(
 # ["make", "html"],
 # cwd=(result.project_dir / "docs"),
 # )

 # return sphinx_results.returncode == 0

 return sphinx_results.returncode == 0


def github_workflows_are_valid(result):
 """Test to ensure that the GitHub workflows are valid"""
 workflows_results = subprocess.run(
Expand All@@ -95,14 +125,9 @@ def test_all_defaults(copie):
 result = copie.copy()

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert not pylint_runs_successfully(result)

 # make sure that some basic files were created
 assert (result.project_dir / "README.md").is_file()
 assert (result.project_dir / "pyproject.toml").is_file()
 assert contains_required_files(result)

 # check to see if the README file was hydrated with copier answers.
 found_line = False
Expand DownExpand Up@@ -130,10 +155,9 @@ def test_use_black_and_no_example_modules(copie):
 result = copie.copy(extra_answers=extra_answers)

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert pylint_runs_successfully(result)
 assert contains_required_files(result)

 # make sure that the files that were not requested were not created
 assert not (result.project_dir / "src/example_package/example_module.py").is_file()
Expand DownExpand Up@@ -174,6 +198,7 @@ def test_code_style_combinations(copie, enforce_style):
 result = copie.copy(extra_answers=extra_answers)
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert contains_required_files(result)
 # black would still run successfully.
 assert black_runs_successfully(result)

Expand DownExpand Up@@ -202,6 +227,7 @@ def test_smoke_test_notification(copie, notification):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)


@pytest.mark.parametrize(
Expand All@@ -226,6 +252,8 @@ def test_doc_combinations(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert docs_build_successfully(result)
 assert (result.project_dir / "docs").is_dir()


Expand All@@ -251,9 +279,10 @@ def test_doc_combinations_no_docs(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert not (result.project_dir / "docs").is_dir()


def test_github_workflows_schema(copie):
 """Confirm the current GitHub workflows have valid schemas."""
 extra_answers = {
Expand All@@ -263,3 +292,4 @@ def test_github_workflows_schema(copie):
 result = copie.copy(extra_answers=extra_answers)
 initialize_git_project(result)
 assert github_workflows_are_valid(result)
 assert contains_required_files(result)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Install sphinx from docs/requirements.#436

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.

 Sign up for GitHub

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

 Merged

delucchi-cmu
merged 2 commits into

from

Feb 26, 2024
 Merged


Install sphinx from docs/requirements.
#436
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
080bc0e

Install sphinx from docs/requirements.


delucchi-cmu Feb 26, 2024
36ec415

Apply suggestions from code review


delucchi-cmu Feb 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@
# -- sphinx-copybutton configuration ----------------------------------------
## sets up the expected prompt text from console blocks, and excludes it from
## the text that goes into the clipboard.
copybutton_exclude = '.linenos, .gp'
copybutton_exclude = ".linenos, .gp"
copybutton_prompt_text = ">> "

## lets us suppress the copy button on select code blocks.
copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"

# -- Options for autosectionlabel -------------------------------------------------

autosectionlabel_prefix_document=True
autosectionlabel_prefix_document = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.initialize_new_project.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.setup_dev.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

34 changes: 9 additions & 25 deletions
python-project-template/pyproject.toml.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,9 +20,6 @@ classifiers = [
dynamic = ["version"]
requires-python = ">={{ python_versions[0] }}"
dependencies = [
{%- if include_notebooks %}
 "ipykernel", # Support for Jupyter notebooks
{%- endif %}
]

[project.urls]
Expand All@@ -31,36 +28,23 @@ dependencies = [
# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
[project.optional-dependencies]
dev = [
 "pytest",
 "pytest-cov", # Used to report total code coverage
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if include_docs %}
 "sphinx", # Used to automatically generate documentation
 "sphinx-rtd-theme", # Used to render documentation
 "sphinx-autoapi", # Used to automatically generate api documentation
{%- endif %}
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
{%- endif %}
{%- if 'black' in enforce_style %}
 "black", # Used for static linting of files
{%- endif %}
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
{%- if mypy_type_checking != 'none' %}
 "mypy", # Used for static type checking of files
{%- endif %}
{%- if include_notebooks %}
 # if you add dependencies here while experimenting in a notebook and you
 # want that notebook to render in your documentation, please add the
 # dependencies to ./docs/requirements.txt as well.
 "nbconvert", # Needed for pre-commit check to clear output from Python notebooks
 "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation
 "ipython", # Also used in building notebooks into Sphinx
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- endif %}
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
 "pytest",
 "pytest-cov", # Used to report total code coverage
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
]

Expand Down

14 changes: 8 additions & 6 deletions
python-project-template/{% if include_docs %}docs{% endif %}/requirements.txt.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
sphinx
sphinx-rtd-theme
sphinx-autoapi
sphinx-copybutton
{%- if include_notebooks %}
nbsphinx
ipykernel
ipython
jupytext
jupyter
jupytext
nbconvert
nbsphinx
{%- endif %}
sphinx
sphinx-autoapi
sphinx-copybutton
sphinx-rtd-theme

60 changes: 45 additions & 15 deletions
tests/test_package_creation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,26 @@ def successfully_created_project(result):
 return result.exit_code == 0 and result.exception is None and result.project_dir.is_dir()


def contains_required_files(result):
 required_files = [
 ".copier-answers.yml",
 ".git_archival.txt",
 ".gitattributes",
 ".gitignore",
 ".pre-commit-config.yaml",
 ".setup_dev.sh",
 "LICENSE",
 "pyproject.toml",
 "README.md",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found


def directory_structure_is_correct(result, package_name="example_package"):
 """Test to ensure that the default directory structure ws created correctly"""
 return (result.project_dir / f"src/{package_name}").is_dir() and (
Expand DownExpand Up@@ -65,14 +85,24 @@ def docs_build_successfully(result):
 virtual environment for the project.
 """

 sphinx_results = subprocess.run(
 ["make", "html"],
 cwd=(result.project_dir / "docs"),
 )
 required_files = [
 ".readthedocs.yml",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found

 # sphinx_results = subprocess.run(
 # ["make", "html"],
 # cwd=(result.project_dir / "docs"),
 # )

 # return sphinx_results.returncode == 0

 return sphinx_results.returncode == 0


def github_workflows_are_valid(result):
 """Test to ensure that the GitHub workflows are valid"""
 workflows_results = subprocess.run(
Expand All@@ -95,14 +125,9 @@ def test_all_defaults(copie):
 result = copie.copy()

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert not pylint_runs_successfully(result)

 # make sure that some basic files were created
 assert (result.project_dir / "README.md").is_file()
 assert (result.project_dir / "pyproject.toml").is_file()
 assert contains_required_files(result)

 # check to see if the README file was hydrated with copier answers.
 found_line = False
Expand DownExpand Up@@ -130,10 +155,9 @@ def test_use_black_and_no_example_modules(copie):
 result = copie.copy(extra_answers=extra_answers)

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert pylint_runs_successfully(result)
 assert contains_required_files(result)

 # make sure that the files that were not requested were not created
 assert not (result.project_dir / "src/example_package/example_module.py").is_file()
Expand DownExpand Up@@ -174,6 +198,7 @@ def test_code_style_combinations(copie, enforce_style):
 result = copie.copy(extra_answers=extra_answers)
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert contains_required_files(result)
 # black would still run successfully.
 assert black_runs_successfully(result)

Expand DownExpand Up@@ -202,6 +227,7 @@ def test_smoke_test_notification(copie, notification):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)


@pytest.mark.parametrize(
Expand All@@ -226,6 +252,8 @@ def test_doc_combinations(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert docs_build_successfully(result)
 assert (result.project_dir / "docs").is_dir()


Expand All@@ -251,9 +279,10 @@ def test_doc_combinations_no_docs(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert not (result.project_dir / "docs").is_dir()


def test_github_workflows_schema(copie):
 """Confirm the current GitHub workflows have valid schemas."""
 extra_answers = {
Expand All@@ -263,3 +292,4 @@ def test_github_workflows_schema(copie):
 result = copie.copy(extra_answers=extra_answers)
 initialize_git_project(result)
 assert github_workflows_are_valid(result)
 assert contains_required_files(result)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Install sphinx from docs/requirements.#436

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.

 Sign up for GitHub

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

 Merged

delucchi-cmu
merged 2 commits into

from

Feb 26, 2024
 Merged


Install sphinx from docs/requirements.
#436
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
080bc0e

Install sphinx from docs/requirements.


delucchi-cmu Feb 26, 2024
36ec415

Apply suggestions from code review


delucchi-cmu Feb 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@
# -- sphinx-copybutton configuration ----------------------------------------
## sets up the expected prompt text from console blocks, and excludes it from
## the text that goes into the clipboard.
copybutton_exclude = '.linenos, .gp'
copybutton_exclude = ".linenos, .gp"
copybutton_prompt_text = ">> "

## lets us suppress the copy button on select code blocks.
copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"

# -- Options for autosectionlabel -------------------------------------------------

autosectionlabel_prefix_document=True
autosectionlabel_prefix_document = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.initialize_new_project.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

1 change: 1 addition & 0 deletions
python-project-template/.setup_dev.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,7 @@ python -m pip install -e . > /dev/null

echo "Installing developer dependencies in local environment"
python -m pip install -e .'[dev]' > /dev/null
if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi

echo "Installing pre-commit"
pre-commit install > /dev/null
Expand Down

34 changes: 9 additions & 25 deletions
python-project-template/pyproject.toml.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,9 +20,6 @@ classifiers = [
dynamic = ["version"]
requires-python = ">={{ python_versions[0] }}"
dependencies = [
{%- if include_notebooks %}
 "ipykernel", # Support for Jupyter notebooks
{%- endif %}
]

[project.urls]
Expand All@@ -31,36 +28,23 @@ dependencies = [
# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
[project.optional-dependencies]
dev = [
 "pytest",
 "pytest-cov", # Used to report total code coverage
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if include_docs %}
 "sphinx", # Used to automatically generate documentation
 "sphinx-rtd-theme", # Used to render documentation
 "sphinx-autoapi", # Used to automatically generate api documentation
{%- endif %}
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
{%- endif %}
{%- if 'black' in enforce_style %}
 "black", # Used for static linting of files
{%- endif %}
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
{%- if mypy_type_checking != 'none' %}
 "mypy", # Used for static type checking of files
{%- endif %}
{%- if include_notebooks %}
 # if you add dependencies here while experimenting in a notebook and you
 # want that notebook to render in your documentation, please add the
 # dependencies to ./docs/requirements.txt as well.
 "nbconvert", # Needed for pre-commit check to clear output from Python notebooks
 "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation
 "ipython", # Also used in building notebooks into Sphinx
 "pre-commit", # Used to run checks before finalizing a git commit
{%- if 'pylint' in enforce_style %}
 "pylint", # Used for static linting of files
{%- endif %}
{%- if include_benchmarks %}
 "asv==0.6.1", # Used to compute performance benchmarks
 "pytest",
 "pytest-cov", # Used to report total code coverage
{%- if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style %}
 "ruff", # Used for static linting of files
{%- endif %}
]

Expand Down

14 changes: 8 additions & 6 deletions
python-project-template/{% if include_docs %}docs{% endif %}/requirements.txt.jinja

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
sphinx
sphinx-rtd-theme
sphinx-autoapi
sphinx-copybutton
{%- if include_notebooks %}
nbsphinx
ipykernel
ipython
jupytext
jupyter
jupytext
nbconvert
nbsphinx
{%- endif %}
sphinx
sphinx-autoapi
sphinx-copybutton
sphinx-rtd-theme

60 changes: 45 additions & 15 deletions
tests/test_package_creation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,26 @@ def successfully_created_project(result):
 return result.exit_code == 0 and result.exception is None and result.project_dir.is_dir()


def contains_required_files(result):
 required_files = [
 ".copier-answers.yml",
 ".git_archival.txt",
 ".gitattributes",
 ".gitignore",
 ".pre-commit-config.yaml",
 ".setup_dev.sh",
 "LICENSE",
 "pyproject.toml",
 "README.md",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found


def directory_structure_is_correct(result, package_name="example_package"):
 """Test to ensure that the default directory structure ws created correctly"""
 return (result.project_dir / f"src/{package_name}").is_dir() and (
Expand DownExpand Up@@ -65,14 +85,24 @@ def docs_build_successfully(result):
 virtual environment for the project.
 """

 sphinx_results = subprocess.run(
 ["make", "html"],
 cwd=(result.project_dir / "docs"),
 )
 required_files = [
 ".readthedocs.yml",
 ]
 all_found = True
 for file in required_files:
 if not (result.project_dir / file).is_file():
 all_found = False
 print("Required file not generated:", file)
 return all_found

 # sphinx_results = subprocess.run(
 # ["make", "html"],
 # cwd=(result.project_dir / "docs"),
 # )

 # return sphinx_results.returncode == 0

 return sphinx_results.returncode == 0


def github_workflows_are_valid(result):
 """Test to ensure that the GitHub workflows are valid"""
 workflows_results = subprocess.run(
Expand All@@ -95,14 +125,9 @@ def test_all_defaults(copie):
 result = copie.copy()

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert not pylint_runs_successfully(result)

 # make sure that some basic files were created
 assert (result.project_dir / "README.md").is_file()
 assert (result.project_dir / "pyproject.toml").is_file()
 assert contains_required_files(result)

 # check to see if the README file was hydrated with copier answers.
 found_line = False
Expand DownExpand Up@@ -130,10 +155,9 @@ def test_use_black_and_no_example_modules(copie):
 result = copie.copy(extra_answers=extra_answers)

 assert successfully_created_project(result)

 assert directory_structure_is_correct(result)

 assert pylint_runs_successfully(result)
 assert contains_required_files(result)

 # make sure that the files that were not requested were not created
 assert not (result.project_dir / "src/example_package/example_module.py").is_file()
Expand DownExpand Up@@ -174,6 +198,7 @@ def test_code_style_combinations(copie, enforce_style):
 result = copie.copy(extra_answers=extra_answers)
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert contains_required_files(result)
 # black would still run successfully.
 assert black_runs_successfully(result)

Expand DownExpand Up@@ -202,6 +227,7 @@ def test_smoke_test_notification(copie, notification):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)


@pytest.mark.parametrize(
Expand All@@ -226,6 +252,8 @@ def test_doc_combinations(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert docs_build_successfully(result)
 assert (result.project_dir / "docs").is_dir()


Expand All@@ -251,9 +279,10 @@ def test_doc_combinations_no_docs(copie, doc_answers):
 assert successfully_created_project(result)
 assert directory_structure_is_correct(result)
 assert black_runs_successfully(result)
 assert contains_required_files(result)
 assert not (result.project_dir / "docs").is_dir()


def test_github_workflows_schema(copie):
 """Confirm the current GitHub workflows have valid schemas."""
 extra_answers = {
Expand All@@ -263,3 +292,4 @@ def test_github_workflows_schema(copie):
 result = copie.copy(extra_answers=extra_answers)
 initialize_git_project(result)
 assert github_workflows_are_valid(result)
 assert contains_required_files(result)