Skip to content

Commit 99857ce

Browse files
gatesndanking
andauthored
Vortex Docs Reboot (vortex-data#6318)
Signed-off-by: Nicholas Gates <nick@nickgates.com> Signed-off-by: Nicholas Gates <gatesn@users.noreply.github.com> Co-authored-by: Dan King <dan@spiraldb.com>
1 parent 06c84f6 commit 99857ce

101 files changed

Lines changed: 3840 additions & 757 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/ci.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ jobs:
105105
with:
106106
sync: false
107107
prune-cache: false
108+
- name: Install Doxygen
109+
uses: ssciwr/doxygen-install@v1
108110

109111
- name: Pytest - Vortex
110112
run: |

.github/workflows/docs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ jobs:
3232
with:
3333
sync: false
3434
prune-cache: false
35+
- name: Generate changelog from GitHub releases
36+
run: uv run docs/generate_changelog.py
37+
env:
38+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
39+
- name: Install Doxygen
40+
uses: ssciwr/doxygen-install@v1
3541
- name: Generate Javadoc for Java projects
3642
run: |
3743
cd java

CONTRIBUTING.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ The contribution process is outlined below:
3636
3. Open a PR to indicate that the change is ready for review.
3737
- Ensure that you sign your work via DCO (see below).
3838
- Disclose LLM usage as described in [AI Assistance Notice](#ai-assistance-notice).
39+
- CI requires approval from external committers.
3940

4041
## Governance
4142

@@ -80,12 +81,9 @@ Our CI process enforces an extensive set of linter (e.g., `clippy`) rules, as we
8081

8182
## Reporting Issues
8283

83-
The Vortex project triages all issues and feature requests via Discussions.
84-
85-
See #5495 for background on this change.
86-
87-
If you see something that you think is a bug, create a new Discussion and select "Issue Triage"
88-
for the template. Then fill out the form.
84+
Bugs should be filed as [GitHub Issues](https://github.com/vortex-data/vortex/issues). Open-ended
85+
questions and feature requests should be filed as
86+
[GitHub Discussions](https://github.com/vortex-data/vortex/discussions).
8987

9088
## Developer Certificate of Origin (DCO)
9189

docs/Doxyfile.cpp

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Doxygen configuration for Vortex C++ API documentation.
2+
# XML output is consumed by Sphinx via the Breathe extension.
3+
4+
PROJECT_NAME = "Vortex C++"
5+
OUTPUT_DIRECTORY = _build/doxygen-cpp
6+
7+
# Input sources
8+
INPUT = ../vortex-cxx/cpp/include/vortex
9+
FILE_PATTERNS = *.hpp
10+
RECURSIVE = NO
11+
12+
# We only care about XML output for Breathe
13+
GENERATE_XML = YES
14+
GENERATE_HTML = NO
15+
GENERATE_LATEX = NO
16+
XML_PROGRAMLISTING = YES
17+
18+
# Extract everything, even if not fully documented yet
19+
EXTRACT_ALL = YES
20+
EXTRACT_PRIVATE = NO
21+
EXTRACT_STATIC = YES
22+
23+
# Preprocessing — resolve includes but don't expand macros
24+
ENABLE_PREPROCESSING = YES
25+
MACRO_EXPANSION = NO
26+
27+
# Suppress warnings about undocumented members (WIP API)
28+
WARN_IF_UNDOCUMENTED = NO
29+
30+
# Exclude cxx bridge internals from documentation
31+
EXCLUDE_SYMBOLS = ffi::*

docs/Makefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ help:
2020
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2121

2222
serve:
23-
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)/html"
23+
@rm -rf "$(BUILDDIR)"
24+
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)/html" --re-ignore '$(BUILDDIR)/.*'

docs/_static/style.css

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
/* -- Landing page wordmark ------------------------------------------------ */
2+
3+
.vortex-wordmark {
4+
display: block;
5+
max-width: min(400px, 100%);
6+
margin: 1.5rem auto 2.5rem;
7+
}
8+
9+
/* -- Headings ------------------------------------------------------------- */
10+
111
h2 {
212
font-size: 1.75rem;
313
}
@@ -8,4 +18,29 @@ h3 {
818

919
h4 {
1020
font-size: 1.25rem;
11-
}
21+
}
22+
23+
/* -- Landing page cards --------------------------------------------------- */
24+
25+
.sd-card .sd-card-title {
26+
font-size: 1.15rem;
27+
font-weight: 600;
28+
color: var(--pst-color-primary);
29+
border-bottom: 1px solid var(--pst-color-border);
30+
padding-bottom: 0.4rem;
31+
margin-bottom: 0.6rem;
32+
}
33+
34+
.sd-card .sd-card-body {
35+
font-size: 0.92rem;
36+
line-height: 1.55;
37+
}
38+
39+
.sd-card {
40+
transition: box-shadow 0.15s ease-in-out, border-color 0.15s ease-in-out;
41+
}
42+
43+
.sd-card:hover {
44+
border-color: var(--pst-color-primary);
45+
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.08);
46+
}

docs/_static/vortex_logo.svg

Lines changed: 17 additions & 0 deletions
Loading
Lines changed: 17 additions & 0 deletions
Loading

docs/_static/vortex_spiral_logo.svg

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/_static/vortex_spiral_logo_dark_theme.svg

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)