Skip to content

API docs theme styling setup #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

API docs theme styling setup #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c67d575
Victory! Created pydoc & typedoc folders in root to then override the…
travisavc Mar 4, 2025
e091720
PyDocs -- override <head> template (head.html) so we can reference a …
travisavc Mar 5, 2025
e6ea306
fix search input / autosuggest text visibility
travisavc Mar 5, 2025
17fa4b0
Google fonts -- Inter
travisavc Mar 5, 2025
ff325c7
fix main mkdocs Voxel logo, attempted nav override (pending)
travisavc Mar 5, 2025
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
1 change: 1 addition & 0 deletions build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ main() {
--html-output="$API_DOC_DIR" \
--docformat=google \
--intersphinx=https://docs.python.org/3/objects.inv \
--template-dir="$SCRIPT_DIR/pydoctor/pydoctor_templates" \
fiftyone || true

# Check if the output directory was created successfully
Expand Down
Binary file added docs/_static/images/voxel51-logo-white.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions docs/assets/pydoctor-override.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
body, p {
font-family: "Inter", Arial, sans-serif;
}

.navbar-default.mainnavbar {
background-color: rgba(255, 109, 4, 1);
}

.navbar-default.mainnavbar .navlinks a {
color: white !important;
}

.api-logo {
display: inline;
max-width: 24px;
height: auto;
}
4 changes: 2 additions & 2 deletions docs/how_do_i/recipes/draw_labels.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,8 +415,8 @@
"output_type": "stream",
"text": [
"total 34832\r\n",
"drwxr-xr-x 4 Brian wheel 128B Oct 7 23:57 \u001B[34m.\u001B[m\u001B[m\r\n",
"drwxr-xr-x 3 Brian wheel 96B Oct 7 23:57 \u001B[34m..\u001B[m\u001B[m\r\n",
"drwxr-xr-x 4 Brian wheel 128B Oct 7 23:57 \u001b[34m.\u001b[m\u001b[m\r\n",
"drwxr-xr-x 3 Brian wheel 96B Oct 7 23:57 \u001b[34m..\u001b[m\u001b[m\r\n",
"-rw-r--r-- 1 Brian wheel 7.5M Oct 7 23:57 0587e1cfc2344523922652d8b227fba4-000014-video_052.mp4\r\n",
"-rw-r--r-- 1 Brian wheel 8.5M Oct 7 23:58 0587e1cfc2344523922652d8b227fba4-000014-video_164.mp4\r\n"
]
Expand Down
4 changes: 3 additions & 1 deletion docs/how_do_i/recipes/remove_duplicate_annos.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![cvat-remove-dups](images/cvat_remove_dups.webp)"
"source": [
"![cvat-remove-dups](images/cvat_remove_dups.webp)"
]
},
{
"cell_type": "markdown",
Expand Down
36 changes: 26 additions & 10 deletions docs/tutorials/anomaly_detection.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 7 additions & 5 deletions docs/tutorials/classification_mistakes.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,22 +484,24 @@
]
},
{
"metadata": {},
"cell_type": "raw",
"source": "session = fo.launch_app(dataset)"
"metadata": {},
"source": [
"session = fo.launch_app(dataset)"
]
},
{
"metadata": {},
"cell_type": "raw",
"metadata": {},
"source": [
"# Show only the samples that were processed\n",
"session.view = dataset.match_tags(\"processed\")"
]
},
{
"metadata": {},
"cell_type": "markdown",
"source": ""
"metadata": {},
"source": []
},
{
"cell_type": "code",
Expand Down
40 changes: 30 additions & 10 deletions docs/tutorials/clustering.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 21 additions & 7 deletions docs/tutorials/cvat_annotation.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,7 +757,9 @@
"cell_type": "markdown",
"id": "aab91684",
"metadata": {},
"source": "![cvat-seg](images/cvat_segmentation.webp)"
"source": [
"![cvat-seg](images/cvat_segmentation.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -925,7 +927,9 @@
"cell_type": "markdown",
"id": "5a4a98a2",
"metadata": {},
"source": "![cvat-assignee](images/cvat_assignees.webp)"
"source": [
"![cvat-assignee](images/cvat_assignees.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -1022,7 +1026,9 @@
"cell_type": "markdown",
"id": "d3fa0845",
"metadata": {},
"source": "![cvat-tag](images/cvat_tag.webp)"
"source": [
"![cvat-tag](images/cvat_tag.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -1131,7 +1137,9 @@
"cell_type": "markdown",
"id": "5f1b24b9",
"metadata": {},
"source": "![cvat-attrs](images/cvat_attributes.webp)"
"source": [
"![cvat-attrs](images/cvat_attributes.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -1327,7 +1335,9 @@
"cell_type": "markdown",
"id": "9ecc4c1e",
"metadata": {},
"source": "![cvat-segmentation](images/cvat_segmentation_2.webp)"
"source": [
"![cvat-segmentation](images/cvat_segmentation_2.webp)"
]
},
{
"cell_type": "code",
Expand Down Expand Up @@ -1968,7 +1978,9 @@
"cell_type": "markdown",
"id": "aceb5b99",
"metadata": {},
"source": "![cvat-mistake](images/cvat_mistakes.webp)"
"source": [
"![cvat-mistake](images/cvat_mistakes.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -2263,7 +2275,9 @@
"cell_type": "markdown",
"id": "e06e1afc",
"metadata": {},
"source": "![cvat-video](images/cvat_video.webp)"
"source": [
"![cvat-video](images/cvat_video.webp)"
]
},
{
"cell_type": "markdown",
Expand Down
24 changes: 18 additions & 6 deletions docs/tutorials/data_augmentation.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 21 additions & 7 deletions docs/tutorials/detection_mistakes.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 6 additions & 2 deletions docs/tutorials/detectron2.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![tensorboard](images/detectron2_tensorboard.webp)"
"source": [
"![tensorboard](images/detectron2_tensorboard.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -1016,7 +1018,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![pr-curve](images/detectron2_pr.webp)"
"source": [
"![pr-curve](images/detectron2_pr.webp)"
]
},
{
"cell_type": "markdown",
Expand Down
40 changes: 30 additions & 10 deletions docs/tutorials/dimension_reduction.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/tutorials/evaluate_classifications.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3622,10 +3622,10 @@
]
},
{
"metadata": {},
"cell_type": "code",
"outputs": [],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"# Perform test inference\n",
"\n",
Expand Down
68 changes: 51 additions & 17 deletions docs/tutorials/evaluate_detections.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Evaluate Detections Dataset](images/evaluate_detections_dataset.webp)"
"source": [
"![Evaluate Detections Dataset](images/evaluate_detections_dataset.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -269,7 +271,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Predictions View](images/evaluate_detections_prediction_view.webp)"
"source": [
"![Predictions View](images/evaluate_detections_prediction_view.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -302,7 +306,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![All boxes](images/evaluate_detections_all_boxes.webp)"
"source": [
"![All boxes](images/evaluate_detections_all_boxes.webp)"
]
},
{
"cell_type": "markdown",
Expand All @@ -327,7 +333,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Exists Filter](images/evaluate_detections_exists_filter.webp)"
"source": [
"![Exists Filter](images/evaluate_detections_exists_filter.webp)"
]
},
{
"cell_type": "markdown",
Expand All @@ -341,7 +349,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Click Image](images/evaluate_detections_click_image.webp)"
"source": [
"![Click Image](images/evaluate_detections_click_image.webp)"
]
},
{
"cell_type": "markdown",
Expand All @@ -355,7 +365,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Only show selected](images/evaluate_detections_only_show_selected.webp)"
"source": [
"![Only show selected](images/evaluate_detections_only_show_selected.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -396,7 +408,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Confidence Threshold](images/evaluate_detections_confidence_filter.webp)"
"source": [
"![Confidence Threshold](images/evaluate_detections_confidence_filter.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -524,7 +538,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![High Confidence](images/evaluate_detections_high_conf_view.webp)"
"source": [
"![High Confidence](images/evaluate_detections_high_conf_view.webp)"
]
},
{
"cell_type": "markdown",
Expand All @@ -549,7 +565,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Patches View](images/evaluate_detections_gt_patches.webp)"
"source": [
"![Patches View](images/evaluate_detections_gt_patches.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -1157,7 +1175,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Evaluation Patches](images/evaluate_detections_eval_patches.webp)"
"source": [
"![Evaluation Patches](images/evaluate_detections_eval_patches.webp)"
]
},
{
"cell_type": "markdown",
Expand All @@ -1169,7 +1189,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![FP Confidence Filter](images/evaluate_detections_high_conf_fp.webp)"
"source": [
"![FP Confidence Filter](images/evaluate_detections_high_conf_fp.webp)"
]
},
{
"cell_type": "markdown",
Expand All @@ -1195,7 +1217,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Best Samples](images/evaluate_detections_eval_tp.webp)"
"source": [
"![Best Samples](images/evaluate_detections_eval_tp.webp)"
]
},
{
"cell_type": "markdown",
Expand All @@ -1219,7 +1243,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Worst Samples](images/evaluate_detections_eval_fp.webp)"
"source": [
"![Worst Samples](images/evaluate_detections_eval_fp.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -1269,7 +1295,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Small Bboxes](images/evaluate_detections_small_bboxes.webp)"
"source": [
"![Small Bboxes](images/evaluate_detections_small_bboxes.webp)"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -1414,7 +1442,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Crowd Boxes](images/evaluate_detections_crowded.webp)"
"source": [
"![Crowd Boxes](images/evaluate_detections_crowded.webp)"
]
},
{
"cell_type": "markdown",
Expand All @@ -1439,7 +1469,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![Crowd FPs](images/evaluate_detections_crowded_fp.webp)"
"source": [
"![Crowd FPs](images/evaluate_detections_crowded_fp.webp)"
]
},
{
"cell_type": "markdown",
Expand All @@ -1462,7 +1494,9 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "![High Conf Eval FPs Sort](images/evaluate_detections_high_conf_eval_fp.webp)"
"source": [
"![High Conf Eval FPs Sort](images/evaluate_detections_high_conf_eval_fp.webp)"
]
},
{
"cell_type": "markdown",
Expand Down
44 changes: 33 additions & 11 deletions docs/tutorials/image_embeddings.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion docs/tutorials/labelbox_annotation.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,9 @@
"cell_type": "markdown",
"id": "direct-bailey",
"metadata": {},
"source": "![labelbox-detection](images/labelbox_detection.webp)"
"source": [
"![labelbox-detection](images/labelbox_detection.webp)"
]
},
{
"cell_type": "markdown",
Expand Down
Loading
Loading