Skip to content

Commit

Permalink
hello
Browse files Browse the repository at this point in the history
  • Loading branch information
Nandhan-KA committed Feb 6, 2025
1 parent b966342 commit f1e4d5f
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 34 deletions.
8 changes: 8 additions & 0 deletions source/_static/animation.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
window.onload = function () {
const images = document.querySelectorAll('img');
images.forEach(function (img) {
img.style.opacity = 0;
img.style.transition = "opacity 1s ease-in-out";
img.onload = () => { img.style.opacity = 1; };
});
};
26 changes: 25 additions & 1 deletion source/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,28 @@ h1 {
.animated-text {
animation: fadeIn 2s ease-in;
}


img {
transition: transform 0.5s ease, box-shadow 0.5s ease;
}

img:hover {
transform: scale(1.1);
box-shadow: 0px 4px 8px rgba(0, 0, 0, 0.2);
}

.fab-button {
position: fixed;
bottom: 30px;
right: 30px;
padding: 10px 15px;
background-color: #f60;
color: white;
border-radius: 50%;
font-size: 20px;
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
}

.fab-button:hover {
background-color: #d95;
}
22 changes: 12 additions & 10 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@
'sphinx_panels',
'sphinx_tabs.tabs',
'sphinx_copybutton',
'sphinxcontrib.mermaid'
'sphinxcontrib.mermaid',
'sphinx.ext.graphviz', # For diagrams (optional)
]

templates_path = ['_templates']
exclude_patterns = []

# -- Options for HTML output -------------------------------------------------
html_theme = 'alabaster' # Changed to Alabaster
html_theme = 'alabaster' # You mentioned you want the Alabaster theme
html_static_path = ['_static']

# Favicon and logo settings
Expand All @@ -27,16 +28,17 @@

# Theme-specific options for Alabaster
html_theme_options = {
'description': 'Pymodins ',
'github_user': 'Nandhan-KA', # Optional: GitHub username
'github_repo': 'pymodins', # Optional: GitHub repository name
'sidebar_width': '300px',
'page_width': '80%', # Adjust the page width if needed
'show_powered_by': False, # Hide the "powered by" text
# You can adjust the logo path
'favicon': 'favicon.ico', # You can adjust the favicon path
'description': 'Pymodins: Python Module Installer',
'github_user': 'Nandhan-ka',
'github_repo': 'pymodins',
'show_powered_by': False,
'sidebar_width': '250px',
}

# Add custom static files like JS and CSS
html_js_files = ['animation.js']
html_css_files = ['custom.css']

# Code block styling
pygments_style = 'friendly'
pygments_dark_style = 'native'
Expand Down
34 changes: 11 additions & 23 deletions source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@

.. image:: PYMODINS.png
:alt: Pymodins Logo
:align: center
:width: 200px
:data-aos: "fade-up" # Animation when the image comes into view

Welcome to pymodins's Documentation!
=====================================
Expand All @@ -12,29 +14,27 @@ This tool can be used on **Windows** as well as **Linux-based Operating Systems*

**To install with pip:**
- On Windows, run:
```
```bash
pip install pymodins
```
- On Linux, run:
```
```bash
sudo pip3 install pymodins
```

**Source Code:**
The source code is available on [GitHub](https://github.com/Nandhan-ka/pymodins).


**Key Features of pymodins:**
* 🛠️ **Easy Installation:** Install multiple Python modules with a single command.
* 📚 **Domain-Specific Packages:** Choose from various domains like Machine Learning, Deep Learning, Data Visualization, and more.
* 🌱 **Beginner-Friendly:** Simplifies the process of setting up Python environments for beginners.
* 🤖 **Automation:** Automates the installation of commonly used Python packages.
* 🔧 **Extensible:** Open to contributions and can be extended to include more modules and features.
* 🛠️ **Easy Installation:** Install multiple Python modules with a single command.
* 📚 **Domain-Specific Packages:** Choose from various domains like Machine Learning, Deep Learning, Data Visualization, and more.
* 🌱 **Beginner-Friendly:** Simplifies the process of setting up Python environments for beginners.
* 🤖 **Automation:** Automates the installation of commonly used Python packages.
* 🔧 **Extensible:** Open to contributions and can be extended to include more modules and features.
* 🚀 **Cross-Platform Support:** Seamlessly works on both Windows and Linux.
* 📊 **Performance Insights:** Gain insights into package installation performance.
* 🛡️ **Security Enhancements:** Secure handling of package installations.


Getting Started
===============

Expand Down Expand Up @@ -64,6 +64,7 @@ Commands and Usage
:alt: Running pymodins
:align: center
:width: 60%
:data-aos: "fade-in"

2. **Install Basic Modules:**
.. code:: python
Expand All @@ -74,6 +75,7 @@ Commands and Usage
:alt: Installing Basic Modules
:align: center
:width: 60%
:data-aos: "fade-in"

3. **Install Machine Learning Modules:**
.. code:: python
Expand All @@ -85,16 +87,6 @@ Commands and Usage
>>> pymodins.install_data_viz_modules()
.. toctree::
:maxdepth: 2
:caption: Contents:

installation
usage
advanced_features
troubleshooting

Advanced Features
=================

Expand All @@ -114,7 +106,6 @@ Pymodins allows you to install packages based on specific domains such as:

- Comprehensive error messages to guide users.


Troubleshooting
===============

Expand All @@ -129,12 +120,9 @@ Troubleshooting
3. **Version Conflicts:**
Create a virtual environment to avoid conflicts.


This documentation is still a **work in progress**. Stay tuned for more updates!


Indices and Tables
==================

* :ref:`genindex`

0 comments on commit f1e4d5f

Please sign in to comment.