Skip to content

style: update to CODE-OF-CONDUCT.rst, requirements/tests.text and docs/ according to new group standard. #351

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

Merged
merged 2 commits into from
Jul 22, 2025

Conversation

ycexiao
Copy link
Contributor

@ycexiao ycexiao commented Jul 22, 2025

What problem does this PR address?

Closes #350

What should the reviewer(s) do?

Please check the modifications.

… `docs/` according to new group standard.
Copy link

codecov bot commented Jul 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (988f1f1) to head (e001930).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #351   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            9         9           
  Lines          516       516           
=========================================
  Hits           516       516           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@@ -136,7 +136,7 @@ trying to commit again.

Improvements and fixes are always appreciated.

Before contributing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.utils/blob/main/CODE_OF_CONDUCT.rst>`_.
Before contributing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.utils/blob/main/CODE-OF-CONDUCT.rst>`_.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

CODE-OF-CONDUCT.rst

@@ -140,7 +140,7 @@
"github_user": "diffpy",
"github_repo": "diffpy.utils",
"github_version": "main",
"conf_py_path": "/doc/source/",
"conf_py_path": "/docs/source/",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

docs/

@@ -223,7 +223,7 @@

# Output file base name for HTML help builder.
basename = "diffpy.utils".replace(" ", "").replace(".", "")
htmlhelp_basename = basename + "doc"
htmlhelp_basename = basename + "docs"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

docs

@@ -6,7 +6,7 @@ exclude =
__pycache__,
build,
dist,
doc/source/conf.py
docs/source/conf.py
Copy link
Contributor Author

Choose a reason for hiding this comment

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

docs

@@ -10,4 +10,4 @@ python:
- requirements: requirements/docs.txt

sphinx:
configuration: doc/source/conf.py
configuration: docs/source/conf.py
Copy link
Contributor Author

Choose a reason for hiding this comment

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

docs

@ycexiao ycexiao marked this pull request as ready for review July 22, 2025 18:01
@ycexiao
Copy link
Contributor Author

ycexiao commented Jul 22, 2025

@sbillinge , it's ready for review.

@sbillinge sbillinge merged commit 7eb9f5c into diffpy:main Jul 22, 2025
5 checks passed
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.

style: update CODE_OF_CONDUCT.rst, test.txt, and doc/ to new group standard
2 participants