Skip to content
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.

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

Add documentation framework #23

Open
wants to merge 49 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
453a91b
Add documentation framework with Mkdocs Material
kabilar Nov 21, 2024
8dc09c9
Minor text update
kabilar Nov 21, 2024
11a7a61
Add to custom word list for spell check to ignore
kabilar Nov 21, 2024
d1600e5
Add scripts to autogenerate API docs
kabilar Nov 22, 2024
a625ede
Update options for mkdocstrings
kabilar Nov 22, 2024
ea0e21a
Add `mkdocs-section-index` package
kabilar Nov 22, 2024
1cf478b
Update navigation filename
kabilar Nov 22, 2024
17d6486
Remove comment
kabilar Nov 22, 2024
295ae51
Move mkdocs files to `docs/` directory
kabilar Nov 22, 2024
bcfcd6e
Add `CUSTOM_DOMAIN` to GitHub Action
kabilar Nov 22, 2024
4947c64
Update GitHub Action
kabilar Nov 22, 2024
ff1bb54
Update configuration file
kabilar Nov 22, 2024
7ce3d9a
Update Action for new config file location
kabilar Nov 22, 2024
70e5dc0
Update config file
kabilar Nov 22, 2024
d2aa32a
Add plugin to allow for mkdocs.yml file to be in same directory as docs
kabilar Nov 22, 2024
4fe2c40
Add quotes for strings
kabilar Nov 22, 2024
ef76a2c
Add docstring
kabilar Nov 22, 2024
77832b6
Fix path
kabilar Nov 22, 2024
873bed0
Fix path
kabilar Nov 22, 2024
848f481
Update path
kabilar Nov 22, 2024
73e5bfe
chore
calvinchai Nov 26, 2024
01ebfd8
Remove comments
kabilar Nov 26, 2024
c72eb66
Merge branch 'docs' of https://github.com/kabilar/linc-convert into docs
kabilar Nov 26, 2024
19e8791
Merge branch 'main' of https://github.com/lincbrain/linc-convert into…
kabilar Jan 14, 2025
663b899
Add color schemes
kabilar Jan 14, 2025
aee4b9f
Add cname file
kabilar Jan 14, 2025
f43ebcd
Add a manual trigger for GitHub Actions
kabilar Jan 16, 2025
d3112cb
Rename file
kabilar Jan 16, 2025
7badecf
Fix custom domain
kabilar Jan 16, 2025
80748ae
Update path to script
kabilar Jan 16, 2025
d147548
Revert path update
kabilar Jan 16, 2025
7228128
Update `API` path in navigation
kabilar Jan 16, 2025
776439a
Try alternative path
kabilar Jan 16, 2025
9d0c233
Update navigation path
kabilar Jan 16, 2025
b9c0897
Update path
kabilar Jan 16, 2025
a809b09
Fix paths in api docstrings
kabilar Jan 16, 2025
fb96424
Fix path
kabilar Jan 16, 2025
040f65a
Remove nav so that it is autogenerated
kabilar Jan 16, 2025
cd574c3
Update nav file
kabilar Jan 16, 2025
4c3d74a
Update nav file
kabilar Jan 16, 2025
a3fc412
Update path to `nav_file`
kabilar Jan 16, 2025
20f88cc
Add navigation elements to `gen_reg_pages.py`
kabilar Jan 16, 2025
93c91c1
Move mkdocs.yml file up one level
kabilar Jan 16, 2025
24feef3
Move file back
kabilar Jan 16, 2025
fb72aba
Change GitHub Actions since workflow wasn't working
kabilar Jan 16, 2025
e6aa96d
Update nav file path
kabilar Jan 16, 2025
4a9cbec
Update working directory
kabilar Jan 16, 2025
4c24772
Remove publish-docs workflow
kabilar Jan 16, 2025
8530ae0
Update URL for DANDI Docs
kabilar Jan 16, 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
Prev Previous commit
Next Next commit
Add color schemes
  • Loading branch information
kabilar committed Jan 14, 2025
commit 663b8998158b38e50ea33f7bbe52ca3e2e08c22d
14 changes: 12 additions & 2 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -14,8 +14,18 @@ theme:
favicon: img/linc.logo.color+white.notext+square.png
logo: img/linc.logo.color+black.alpha.notext.png
palette:
primary: "deep purple"
accent: "purple"
- scheme: default
toggle:
icon: material/weather-night
name: Dark mode
primary: "deep purple"
accent: "purple"
- scheme: slate
toggle:
icon: material/weather-sunny
name: Light mode
primary: "deep purple"
accent: "purple"
features:
- toc.integrate

Loading