Skip to content

Commit f2e7701

Browse files
committed
Upload complete PortPy documentation site
1 parent cf94284 commit f2e7701

23 files changed

+245
-0
lines changed

.github/workflows/deploy.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Name of this GitHub Actions workflow (shows up in the Actions tab)
2+
name: Deploy MkDocs site to GitHub Pages
3+
4+
# Trigger the workflow when pushing to the "main" branch
5+
on:
6+
push:
7+
branches:
8+
- main
9+
10+
# Allow the workflow to write to the repository (needed to publish to gh-pages)
11+
permissions:
12+
contents: write
13+
14+
# Define the jobs that will run in this workflow
15+
jobs:
16+
deploy: # Name of the job
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
21+
# Step 1: Check out the code from the repository
22+
- name: Checkout repository
23+
uses: actions/checkout@v4
24+
25+
# Step 2: Set up Python (version 3.12) in the runner
26+
- name: Set up Python
27+
uses: actions/setup-python@v5
28+
with:
29+
python-version: "3.12"
30+
31+
# Step 3: Install Python dependencies from requirements.txt located in the root directory
32+
- name: Install dependencies from requirements.txt
33+
run: |
34+
python -m pip install --upgrade pip
35+
pip install -r requirements.txt
36+
37+
# Step 4: Build the MkDocs site (outputs HTML to ./site)
38+
- name: Build MkDocs site
39+
run: mkdocs build
40+
41+
- name: Deploy to GitHub Pages
42+
uses: peaceiris/actions-gh-pages@v4
43+
with:
44+
github_token: ${{ secrets.GITHUB_TOKEN }} # Auth token for pushing
45+
publish_dir: ./site # Directory to deploy (default MkDocs output)

docs/about.md

Whitespace-only changes.

docs/api/portpy.md

Whitespace-only changes.

docs/contributing.md

Whitespace-only changes.

docs/datasets.md

Whitespace-only changes.

docs/examples.md

Whitespace-only changes.

docs/getting-started.md

Whitespace-only changes.

docs/images/PortPy_logo.jpg

180 KB
Loading

docs/images/PortPy_logo.png

215 KB
Loading

docs/index.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# PortPy
2+
3+
> Modern Portfolio Optimization in Python
4+
5+
---
6+
7+
Welcome to **PortPy**! Effortlessly optimize, analyze, and visualize your investment portfolios with a modern, user-friendly Python library.
8+
9+
<div align="center">
10+
<img src="https://raw.githubusercontent.com/your-org/portpy/main/assets/logo.png" alt="PortPy Logo" width="180"/>
11+
</div>
12+
13+
---
14+
15+
## 🚀 Features
16+
17+
- **Intuitive API** for portfolio construction and optimization
18+
- **Interactive visualizations** for risk and return analysis
19+
- **Jupyter notebook support** for reproducible research
20+
- **Extensive documentation** and real-world examples
21+
22+
---
23+
24+
## Get Started
25+
26+
- [Installation Guide](installation.md)
27+
- [Quickstart Tutorial](quickstart.md)
28+
- [API Reference](reference/)
29+
- [GitHub Repository](https://github.com/your-org/portpy)
30+
31+
---
32+
33+
## Why PortPy?
34+
35+
- Built for both beginners and professionals
36+
- Actively maintained and open source
37+
- Integrates seamlessly with the Python data science stack
38+
39+
---
40+
41+
<div align="center">
42+
<a href="quickstart.md"><b>Start Optimizing Your Portfolio →</b></a>
43+
</div>
44+

0 commit comments

Comments
 (0)