docs: cleanup the docs

.gitignore

@@ -70,6 +70,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+_build/
 
 # PyBuilder
 .pybuilder/
@@ -156,4 +157,4 @@ cython_debug/
 .nodeenv/*
 .DS_Store
 
-node_modules/*
+node_modules/*

.pre-commit-config.yaml

@@ -3,4 +3,15 @@ repos:
   rev: 'v4.0.0-alpha.8'
   hooks:
   - id: prettier
-    types_or: [css, javascript, scss]
+    types_or: [css, javascript, scss]
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  # ref: https://github.com/pre-commit/pre-commit-hooks#hooks-available
+  hooks:
+    # Autoformat: Makes sure files end in a newline and only a newline.
+    - id: end-of-file-fixer
+    # Lint: Check for files with names that would conflict on a
+    # case-insensitive filesystem like MacOS HFS+ or Windows FAT.
+    - id: check-case-conflict
+    - id: trailing-whitespace

README.md

@@ -12,20 +12,5 @@ github.com/pydata/sphinx-theme) for use with the [pyOpenSci](https://pyopensci.o
 ## Contributors
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tbody>
-    <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Revathyvenugopal162"><img src="https://avatars.githubusercontent.com/u/104772255?v=4?s=100" width="100px;" alt="Revathy Venugopal"/><br /><sub><b>Revathy Venugopal</b></sub></a><br /><a href="https://github.com/pyOpenSci/pyos-sphinx-theme/commits?author=Revathyvenugopal162" title="Code">💻</a> <a href="https://github.com/pyOpenSci/pyos-sphinx-theme/pulls?q=is%3Apr+reviewed-by%3ARevathyvenugopal162" title="Reviewed Pull Requests">👀</a></td>
-    </tr>
-  </tbody>
-</table>
 
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

docs/conf.py

@@ -30,9 +30,10 @@
 html_copy_source = True
 html_sourcelink_suffix = ""
 
+html_static_path = ["_static"]
 
 html_theme_options = {
-    "repository_url": "https://github.com/pyOpenSci/pyos-sphinx-theme",
+    "github_url": "https://github.com/pyOpenSci/pyos-sphinx-theme",
     "use_edit_page_button": True,
 }
 
@@ -41,4 +42,4 @@
     "github_repo": "pyos-sphinx-theme",
     "github_version": "main",
     "doc_path": "docs",
-}
+}

docs/develop.md

@@ -7,8 +7,17 @@ This will download a local copy of NodeJS and build the theme's assets with the
 
 ## Theme structure
 
-This theme follows the [`sphinx-theme-builder` filesystem layout](https://sphinx-theme-builder.readthedocs.io/en/latest/reference/filesystem-layout/).
+This theme follows the [`sphinx-theme-builder` filesystem layout](https://sphinx-theme-builder.readthedocs.io/en/latest/filesystem-layout/).
 
+## clone the repository
+
+To develop this theme, clone the repository and install the dependencies:
+
+```bash
+git clone https://github.com/pyOpenSci/pyos-sphinx-theme.git
+cd pyos-sphinx-theme
+pip install -e .[dev]
+```
 
 ## Build the theme locally
 

docs/index.md

@@ -1,33 +1,21 @@
 # The pyOpenSci documentation theme
 
-A lightweight theme built on the Sphinx Book Theme, for use by 2i2c.
-It makes minimal changes to the `sphinx-book-theme` in order to standardize a top-bar that can be shared across all 2i2c documentation.
+A lightweight theme built on the pydata sphinx theme for use with the [pyOpenSci](https://pyopensci.org) project.
+It makes minimal changes to the `pydata sphinx theme` in order to standardize a top-bar that can be shared across all pyOpenSci projects.
 
 It does these two primary things:
 
-- Overrides the `layout.html` template so that we include a topbar of links and a standard footer.
-- Adds some CSS that standardizes the look and feel according to 2i2c colors
+- Adds some CSS that standardizes the look and feel according to the pyOpenSci brand.
 
-Other than this, the theme behaves the exact same as the [sphinx book theme](https://sphinx-book-theme.readthedocs.io).
+Other than this, the theme behaves the exact same as the [pydata sphinx theme](https://pydata-sphinx-theme.readthedocs.io).
 
 ## User guide
 
 These have sections about using this theme
 
 ```{toctree}
 :hidden:
-
-features
 use
 develop
 showcase
 ```
-
-## Reference
-
-See the kitchen sink for some example pages.
-<!-- 
-```{toctree}
-:maxdepth: 3
-reference/kitchen-sink/index
-``` -->