Update names

.binder/postBuild

@@ -1,20 +1,20 @@
 # pip install main
 pip install --no-deps .
-# Note: This produces build and pyiron_module_template.egg-info directories
+# Note: This produces build and sphinx.egg-info directories
 
 # clean up
 if [ -d "notebooks" ]; then
     mv notebooks/* .
 fi
-if [ -d "${HOME}/pyiron_module_template" ]; then
+if [ -d "${HOME}/sphinx" ]; then
     rm -r   ${HOME}/.binder \
             ${HOME}/.ci_support \
             ${HOME}/.github \
             ${HOME}/build \
             ${HOME}/docs \
             ${HOME}/notebooks \
-            ${HOME}/pyiron_module_template \
-            ${HOME}/pyiron_module_template.egg-info \
+            ${HOME}/sphinx \
+            ${HOME}/sphinx.egg-info \
             ${HOME}/tests \
             ${HOME}/.gitattributes \
             ${HOME}/.gitignore \

.coveragerc

@@ -1,5 +1,5 @@
 # .coveragerc to control coverage.py
 [run]
-source = pyiron_module_template
-omit = pyiron_module_template/_version.py
+source = sphinx
+omit = sphinx/_version.py
 concurrency = multiprocessing

.gitattributes

@@ -1 +1 @@
-pyiron_module_template/_version.py export-subst
+sphinx/_version.py export-subst

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,6 +1,6 @@
 ---
 name: Bug report
-about: Create a bug report to help us eliminate issues and improve pyiron_module_template
+about: Create a bug report to help us eliminate issues and improve sphinx
 title: ''
 labels: bug
 assignees: ''

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,6 @@
 ---
 name: Feature request
-about: Make a suggestion for a new feature or a change to pyiron_module_template
+about: Make a suggestion for a new feature or a change to sphinx
 title: ''
 labels: enhancement
 assignees: ''
@@ -13,7 +13,7 @@ assignees: ''
 
 **Detailed Description**
 
-<!--Please explain how you would like to see pyiron_module_template enhanced, what feature(s) you are looking for, what specific problems this will solve.-->
+<!--Please explain how you would like to see sphinx enhanced, what feature(s) you are looking for, what specific problems this will solve.-->
 
 **Further Information, Files, and Links**
 

docs/conf.py

@@ -66,7 +66,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'pyiron_module_template'
+project = u'sphinx'
 copyright = u'2024, Max-Planck-Institut für Nachhaltige Materialien GmbH - Computational Materials Design (CM) Department ' \
             u'All rights reserved'
 
@@ -244,7 +244,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'pyiron_module_template.tex', u'pyiron_module_template Documentation',
+  ('index', 'sphinx.tex', u'sphinx Documentation',
    u'Max-Planck-Institut für Nachhaltige Materialien GmbH - Computational Materials Design (CM) Department', 'manual'),
 ]
 
@@ -275,8 +275,8 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index',
-     'pyiron_module_template',
-     u'pyiron_module_template Documentation',
+     'sphinx',
+     u'sphinx Documentation',
      [u'Max-Planck-Institut für Nachhaltige Materialien GmbH - Computational Materials Design (CM) Department'], 1)
 ]
 
@@ -291,10 +291,10 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
   ('index',
-   'pyiron_module_template',
-   u'pyiron_module_template Documentation',
+   'sphinx',
+   u'sphinx Documentation',
    u'Max-Planck-Institut für Nachhaltige Materialien GmbH - Computational Materials Design (CM) Department',
-   'pyiron_module_template',
+   'sphinx',
    'One line description of project.',
    'Miscellaneous'),
 ]
@@ -311,7 +311,7 @@
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 # texinfo_no_detailmenu = False
 
-main(['-e', '-o', 'apidoc', '../pyiron_module_template', '--force'])
+main(['-e', '-o', 'apidoc', '../sphinx', '--force'])
 
 curdir = os.path.dirname(os.path.abspath(__file__))
 if os.path.exists(os.path.join(curdir, 'source/notebooks')):

docs/index.rst

@@ -1,4 +1,4 @@
-.. pyiron_module_template documentation master file
+.. sphinx documentation master file
 
 .. _index:
 

notebooks/example.ipynb

@@ -19,8 +19,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import pyiron_module_template\n",
-    "print(pyiron_module_template.__version__)"
+    "import sphinx\n",
+    "print(sphinx.__version__)"
    ]
   }
  ],

pyproject.toml

@@ -7,8 +7,8 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "pyiron_module_template"
-description = "pyiron_module_template - Your pyiron-like module."
+name = "sphinx"
+description = "sphinx - Your pyiron-like module."
 readme = "docs/README.md"
 keywords = [ "pyiron",]
 requires-python = ">=3.9, <3.13"
@@ -36,18 +36,18 @@ file = "LICENSE"
 
 [project.urls]
 Homepage = "https://pyiron.org/"
-Documentation = "https://pyiron_module_template.readthedocs.io"
-Repository = "https://github.com/pyiron/pyiron_module_template"
+Documentation = "https://sphinx.readthedocs.io"
+Repository = "https://github.com/pyiron/sphinx"
 
 [tool.versioneer]
 VCS = "git"
 style = "pep440-pre"
-versionfile_source = "pyiron_module_template/_version.py"
-parentdir_prefix = "pyiron_module_template"
-tag_prefix = "pyiron_module_template-"
+versionfile_source = "sphinx/_version.py"
+parentdir_prefix = "sphinx"
+tag_prefix = "sphinx-"
 
 [tool.setuptools.packages.find]
-include = [ "pyiron_module_template*",]
+include = [ "sphinx*",]
 
 [tool.setuptools.dynamic.version]
-attr = "pyiron_module_template.__version__"
+attr = "sphinx.__version__"

pyiron_module_template/_version.py → sphinx/_version.py

@@ -50,9 +50,9 @@ def get_config() -> VersioneerConfig:
     cfg = VersioneerConfig()
     cfg.VCS = "git"
     cfg.style = "pep440-pre"
-    cfg.tag_prefix = "pyiron_module_template-"
-    cfg.parentdir_prefix = "pyiron_module_template"
-    cfg.versionfile_source = "pyiron_module_template/_version.py"
+    cfg.tag_prefix = "sphinx-"
+    cfg.parentdir_prefix = "sphinx"
+    cfg.versionfile_source = "sphinx/_version.py"
     cfg.verbose = False
     return cfg
 

tests/unit/test_tests.py

@@ -1,9 +1,9 @@
 import unittest
-import pyiron_module_template
+import sphinx
 
 
 class TestVersion(unittest.TestCase):
     def test_version(self):
-        version = pyiron_module_template.__version__
+        version = sphinx.__version__
         print(version)
         self.assertTrue(version.startswith('0'))