[repo-helper] Configuration Update

README.rst

@@ -4,8 +4,8 @@ Contributing Guide
 
 .. start short_desc
 
-**Contributing guide for repo-helper and associated projects**
+**Contributing guide for PyMassSpec and associated projects**
 
 .. end short_desc
 
-View online at https://contributing.repo-helper.uk
+View online at https://contributing-to-pyms.readthedocs.io

contributing/__init__.py

@@ -2,7 +2,7 @@
 #
 #  __init__.py
 """
-Contributing guide for repo-helper and associated projects.
+Contributing guide for PyMassSpec and associated projects.
 """
 #
 #  Copyright © 2020-2021 Dominic Davis-Foster <[email protected]>

doc-source/_templates/base.html

@@ -2,4 +2,5 @@
 {% extends "!base.html" %}
 {% block extrahead %}
 	<link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
+	<link rel=icon href=https://pymassspec.github.io/assets/PyMassSpec.ico sizes="48x48" type="image/vnd.microsoft.icon">
 {% endblock %}

doc-source/conf.py

@@ -71,13 +71,28 @@
 		}
 
 
+# Fix for pathlib issue with sphinxemoji on Python 3.9 and Sphinx 4.x
+def copy_asset_files(app, exc):
+	# 3rd party
+	from domdf_python_tools.compat import importlib_resources
+	from sphinx.util.fileutil import copy_asset
+
+	if exc:
+		return
+
+	asset_files = ["twemoji.js", "twemoji.css"]
+	for path in asset_files:
+		path_str = os.fspath(importlib_resources.files("sphinxemoji") / path)
+		copy_asset(path_str, os.path.join(app.outdir, "_static"))
+
+
 def setup(app):
 	# 3rd party
 	from sphinx_toolbox.latex import better_header_layout
 	from sphinxemoji import sphinxemoji
 
 	app.connect("config-inited", lambda app, config: better_header_layout(config))
-	app.connect("build-finished", sphinxemoji.copy_asset_files)
+	app.connect("build-finished", copy_asset_files)
 	app.add_js_file("https://unpkg.com/twemoji@latest/dist/twemoji.min.js")
 	app.add_js_file("twemoji.js")
 	app.add_css_file("twemoji.css")
@@ -87,4 +102,5 @@ def setup(app):
 nitpicky = True
 del version
 del release
-html_title = "repo-helper Contributing Guide"
+html_title = "PyMassSpec Contributing Guide"
+html_logo = "PyMassSpec_262.png"

doc-source/getting-started.rst

@@ -49,7 +49,7 @@ With bash:
 
 .. code-block:: bash
 
-	(repo-helper) $
+	(PyMassSpec) $
 
 
 .. _GitHub: https://github.com/

doc-source/index.rst

@@ -23,3 +23,7 @@ Contributing Guide
 	documentation
 	building
 	release-process
+
+.. sidebar-links::
+	:caption: Links
+	:github:

doc-source/requirements.txt

@@ -12,6 +12,12 @@ sphinx-prompt>=1.1.0
 sphinx-pyproject>=0.1.0
 sphinx-tabs>=1.1.13
 sphinx-toolbox>=3.5.0
+sphinxcontrib-applehelp==1.0.4
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.1
 sphinxcontrib-httpdomain>=1.7.0
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
 sphinxemoji>=0.1.6
 toctree-plus>=0.6.1

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "whey"
 [project]
 name = "contributing"
 version = "2021.0.0"
-description = "Contributing guide for repo-helper and associated projects"
+description = "Contributing guide for PyMassSpec and associated projects"
 readme = "README.rst"
 keywords = []
 dynamic = [ "requires-python", "classifiers", "dependencies",]
@@ -18,10 +18,10 @@ name = "Dominic Davis-Foster"
 email = "[email protected]"
 
 [project.urls]
-Homepage = "https://github.com/repo-helper/contributing"
-"Issue Tracker" = "https://github.com/repo-helper/contributing/issues"
-"Source Code" = "https://github.com/repo-helper/contributing"
-Documentation = "https://contributing.repo-helper.uk"
+Homepage = "https://github.com/PyMassSpec/contributing"
+"Issue Tracker" = "https://github.com/PyMassSpec/contributing/issues"
+"Source Code" = "https://github.com/PyMassSpec/contributing"
+Documentation = "https://contributing-to-pyms.readthedocs.io"
 
 [tool.whey]
 base-classifiers = []
@@ -33,7 +33,7 @@ license-key = "MIT"
 [tool.importcheck]
 
 [tool.sphinx-pyproject]
-github_username = "repo-helper"
+github_username = "PyMassSpec"
 github_repository = "contributing"
 author = "Dominic Davis-Foster"
 project = "contributing"

repo_helper.yml

@@ -4,19 +4,20 @@ modname: 'contributing'
 copyright_years: '2020-2021'
 author: 'Dominic Davis-Foster'
 email: '[email protected]'
-username: 'repo-helper'
+username: 'PyMassSpec'
 assignee: 'domdfcoding'
 version: '2021.0.0'
 license: 'MIT'
-short_desc: 'Contributing guide for repo-helper and associated projects'
+short_desc: 'Contributing guide for PyMassSpec and associated projects'
 
 use_whey: True
 docs_fail_on_warning: true
 sphinx_html_theme: furo
 enable_tests: false
 enable_conda: false
 on_pypi: false
-docs_url: https://contributing.repo-helper.uk
+docs_url: https://contributing-to-pyms.readthedocs.io
+preserve_custom_theme: true
 
 python_versions:
  - '3.8'
@@ -25,7 +26,8 @@ sphinx_conf_epilogue:
  - nitpicky = True
  - del version
  - del release
- - html_title = "repo-helper Contributing Guide"
+ - html_title = "PyMassSpec Contributing Guide"
+ - html_logo = "PyMassSpec_262.png"
 
 extra_sphinx_extensions:
  - html_section