Fix Requested Changes

Author: richarddushime

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

docs/source/_static/css/custom.css

@@ -34,7 +34,6 @@
     align-items: center;
 }
 
-/* Rest of your existing styles remain */
 .navbar-brand-logo img { height: 40px; }
 .nav-link { color: white !important; font-weight: 500; }
 .icon-link { color: white !important; font-size: 1.2rem; }
@@ -58,36 +57,3 @@
         order: 1;
     }
 }
-
-/* Search field positioning */
-.navbar-search {
-    margin-left: auto;
-    flex: 0 0 250px;
-}
-.bd-search {
-    display: flex;
-    gap: 1rem;
-    float: right;
-    position: relative;
-}
-
-/* Search input styling */
-.bd-search .form-control {
-    background: rgba(255, 255, 255, 0.1) !important;
-    border: 1px solid rgba(255, 255, 255, 0.3) !important;
-    color: white !important;
-    padding: 0.5rem 1rem !important;
-}
-
-.bd-search .btn {
-    color: rgba(255, 255, 255, 0.7) !important;
-}
-
-/* Mobile responsiveness */
-@media (max-width: 768px) {
-    .navbar-search {
-        flex: 1 1 100%;
-        order: 3;
-        margin-top: 1rem;
-    }
-}

docs/source/_static/favicon.ico

@@ -1,34 +1,14 @@
 <nav class="bd-navbar navbar">
-  <!-- Left: Logo -->
-  <div class="navbar-brand">
-    <a class="navbar-brand-logo" href="{{ pathto(master_doc) }}">
-      <img src="{{ pathto('_static/logo.png', 1) }}" alt="{{ project }} logo">
-    </a>
-  </div>
-
   <!-- Center: Navigation items -->
   <div class="navbar-center-group">
     <ul class="nav navbar-nav">
       <li class="nav-item">
-        <a class="nav-link" href="https://cookiecutter-data-science.drivendata.org/">About</a>
+        <a class="nav-link" href="{{ pathto('index') }}">About</a>
       </li>
       <li class="nav-item">
         <a class="nav-link" href="{{ pathto('contributing') }}">Contribute</a>
       </li>
     </ul>
-
-    <div class="navbar-icons">
-      <a href="https://github.com/neuroinformatics-unit/python-cookiecutter" class="icon-link" title="GitHub">
-        <i class="fab fa-github">GitHub</i>
-      </a>
-      <a href="https://github.com/yourusername/cookiecutter-python/stargazers" class="icon-link" title="Give us a Star">
-        <i class="fas fa-star" style="color: gold;">Give a Star</i>
-      </a>
-    </div>
   </div>
 
-  <!-- Right: Custom Search -->
-  <div class="navbar-search">
-    {% include "search-field.html" %}
-  </div>
 </nav>

docs/source/_templates/navbar.html

@@ -1,61 +1,91 @@
 # conf.py
-
-# -- Project information -----------------------------------------------------
+# Configuration file for the Sphinx documentation builder.
 project = 'cookiecutter-python'
-author = 'Name'
-release = '0.1.0'
+copyright = "2025, Neuroinformatics Unit"
+author = 'NIU'
+release = "1.0.0"
 
 # -- General configuration ---------------------------------------------------
 extensions = [
     "myst_parser",
     "sphinx_design",
     "sphinx.ext.autodoc",
-    "sphinx.ext.napoleon"
+    "sphinx.ext.napoleon",
+    "sphinx.ext.githubpages",
+    "sphinx_autodoc_typehints",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
+    "sphinx_sitemap",
+    "nbsphinx",
 ]
 
+# Configure MyST Parser
 myst_enable_extensions = [
     "colon_fence",
     "deflist",
+    "fieldlist",
+    "html_admonition",
+    "html_image",
     "linkify",
+    "replacements",
+    "smartquotes",
     "substitution",
     "tasklist",
+    "attrs_inline"
 ]
 
+myst_heading_anchors = 4
+
 source_suffix = {
     '.md': 'markdown',
     '.rst': 'restructuredtext'
 }
 
 templates_path = ['_templates']
+exclude_patterns = [
+    "**.ipynb_checkpoints",
+    "**/includes/**",
+]
 
 # -- HTML output options -----------------------------------------------------
 html_theme = 'pydata_sphinx_theme'
 html_logo = "_static/logo.png"
 html_static_path = ["_static"]
+html_title = "Python Cookiecutter"
+html_favicon = "_static/favicon.ico"
+html_show_sourcelink = False
 
 html_theme_options = {
-    # Disable all default search locations
-    "navbar_end": [],  
-    "navbar_persistent": [],  
-    
-    # Configure navbar
-    "navbar_start": [],
-    "navbar_center": ["navbar.html"],  
-    "navbar_end": [],
-    
-    # Disable right sidebar and TOC
-    "show_toc_level": 0,
-    "secondary_sidebar_items": [],
-    
-    # Keep other settings
+    "navbar_start": ["navbar-logo"],
+    "navbar_center": ["navbar.html"],
+    "navbar_end": ["theme-switcher", "navbar-icon-links"],
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/neuroinformatics-unit/python-cookiecutter",
+            "icon": "fa-brands fa-github",
+            "type": "fontawesome",
+        }
+    ],
+    "logo": {
+        "text": "Python Cookiecutter",
+        "image_light": "logo.png",
+        "image_dark": "logo.png",
+    },
     "show_nav_level": 2,
     "navigation_depth": 3,
     "collapse_navigation": True,
 }
 
+# Sitemap configuration
+html_baseurl = "https://neuroinformatics-unit.github.io/python-cookiecutter/"
+sitemap_url_scheme = "{link}"
+
+  
 html_sidebars = {
-    "**": ["sidebar-nav.html", "search-field.html"]
+    "**": ["sidebar-nav.html"]
 }
 
 def setup(app):
-    app.add_css_file("css/custom.css")
+    app.add_css_file("css/custom.css")

docs/source/_templates/search-field.html

@@ -0,0 +1,81 @@
+# Contributing to cookiecutter-python
+
+Thank you for considering contributing to cookiecutter-python! We welcome contributions that improve the project, whether it's code,
+documentation, or enhancements.
+
+Please follow the guidelines below to ensure a smooth process.
+
+1. **Fork and Clone the Repository** Fork the main repository on
+    GitHub, then clone your fork locally:
+
+    ``` sh
+    git clone https://github.com/<your-username>/python-cookiecutter.git
+    cd python-cookiecutter
+    ```
+
+2. **Create a New Branch** Create and switch to a new branch for your
+    changes:
+
+    ``` sh
+    git checkout -b my_new_feature
+    ```
+
+3. **Make Your Changes** Edit the content, code, or
+    documentation as needed. When you're ready, add and commit your
+    changes with a descriptive message:
+
+    ``` sh
+    git add .
+    git commit -m "Describe your changes in short here"
+    ```
+
+4. **Push Your Branch and Create a Pull Request** Push the new branch
+    to GitHub:
+
+    ``` sh
+    git push origin --set-upstream origin my_new_feature
+    ```
+
+    Then, open a pull request against the ``main`` branch of the main repository. This will automatically trigger a GitHub Action to verify that the builds correctly.
+
+5. **Review and Merge** If the build checks pass, assign someone to review your pull request. Once approved and merged into the ``main`` branch, another GitHub Action will build and add your changes to the ``main`` branch.
+
+
+## Documentation Local Testing
+
+If you are contributing to the Documentation, Before pushing your changes, you can test locally:
+
+-   **First-Time Setup:** Install the required dependencies and build
+    the docs:
+
+    ``` sh
+    pip install -r docs/requirements.txt
+    sphinx-build docs/source docs/build
+    ```
+
+Alternatively, you can use the following commands to install the
+dependencies and build the docs:
+
+ ``` sh
+pip install -r docs/requirements.txt
+cd docs
+make html
+```
+
+- **Rebuilding:** Each time you update the documentation,
+    rebuild the docs by running:
+
+    ``` sh
+    rm -rf docs/build && sphinx-build docs/source docs/build
+    ```
+    or
+
+    ```sh
+    cd docs
+    make clean && make html
+    ```
+
+    Then, open `docs/build/index.html` in your browser to preview the changes.
+
+
+Thank you for your contributions!