Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 153 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/
_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
Pipfile.lock

# poetry
poetry.lock

# pdm
.pdm.toml
.pdm-python
.pdm-build/

# PEP 582
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# IDEs
.vscode/
.idea/
*.swp
*.swo
*~

# OS
.DS_Store
Thumbs.db

.playwright-cli/
.claude/settings.local.json
18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version, and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.13"

commands:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- uv venv $READTHEDOCS_VIRTUALENV_PATH
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv run python -m sphinx -T -b html -d docs/_build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
24 changes: 24 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= uv run sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile autobuild

# Auto-rebuild and serve documentation with live reload
autobuild:
uv run sphinx-autobuild --ignore ".playwright-cli/*" "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O) --open-browser

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
89 changes: 89 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Dask.org Website

This repository contains the Dask.org website built with Sphinx and MyST Markdown to allow for easier content management in the future.

## Project Structure

```
dask.org/
├── _build/ # Generated HTML output
├── _static/ # Static assets (CSS, JS, images)
│ ├── css/ # Stylesheets
│ ├── js/ # JavaScript files
│ ├── images/ # Images and logos
│ └── original/ # Original downloaded website (reference)
├── _templates/ # Sphinx templates
│ └── page.html # Main page template (exact replica)
├── conf.py # Sphinx configuration
├── index.md # Main page content (for future refactoring)
├── pyproject.toml # Python dependencies
├── Makefile # Build commands
└── README.md # This file
```

## Setup

### Prerequisites

- Python 3.9 or higher
- [uv](https://github.com/astral-sh/uv) (recommended) or pip

### Installation

The project uses `uv` for dependency management. Dependencies will be automatically installed when you run build commands.

## Building the Site

### One-time Build

```bash
uv run sphinx-build -b html . _build/html
```

Or using Make:

```bash
make html
```

### Live Preview with Auto-rebuild

For development, use the autobuild feature which watches for changes and automatically rebuilds:

```bash
make autobuild
```

This will:
- Build the documentation
- Start a local web server at http://127.0.0.1:8000
- Watch for file changes and automatically rebuild
- Open your browser to preview the site

## Configuration

Key Sphinx settings in `conf.py`:

- **Theme**: `basic` (minimal, allows custom template)
- **Extensions**: `myst_parser` for Markdown support
- **Static files**: Served from `_static/`
- **Templates**: Custom templates in `_templates/`

## Maintenance

### Updating Assets

To update CSS, JavaScript, or images:

1. Place new files in the appropriate `_static/` subdirectory
2. Update references in `_templates/page.html` if needed
3. Rebuild the site

### Modifying Content

Currently, the content is embedded in the template. A long term goal is to factor that our into markdown that can be built with sphinx. Until then to make changes edit `_templates/page.html` directly.

## License

The Dask project is licensed under the New BSD License. See the [Dask repository](https://github.com/dask/dask) for details.

Binary file removed _images/HHMI_Janelia_Color.png
Binary file not shown.
Binary file removed _images/SponsoredProject.png
Binary file not shown.
30 changes: 0 additions & 30 deletions _images/Xarray-Spatial-logo.svg

This file was deleted.

Binary file removed _images/cesium-logo.png
Binary file not shown.
Binary file removed _images/conda-forge.png
Binary file not shown.
Loading