Skip to content

Update documentation system (migrate to Mkdocs) #562

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

Draft
wants to merge 97 commits into
base: main
Choose a base branch
from
+20,565 −26,994
Draft

Update documentation system (migrate to Mkdocs) #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
97 commits
Select commit Hold shift + click to select a range
2a2198e
Initial commit for migration to Mkdocs.
Feb 21, 2025
1771f79
Restore markdown from previous pandoc/ruby version to better track ch…
Feb 21, 2025
dc51d3c
Add autorefs plugin and translate links for use with the plugin.
Feb 21, 2025
9a4681b
Use autorefs for the few outliers that were remaining.
Feb 27, 2025
016e8bd
Remove unused dependencies and alphabetize plugins.
Feb 28, 2025
cf82367
Add custom js for Katex rendering.
Feb 28, 2025
67be4bc
Clean up index file.
Feb 28, 2025
03b63c6
Reset tables in input-data index.md (will be updated with mkdocs macr…
Feb 28, 2025
467fc24
Reset input data folder.
Feb 28, 2025
6e0b22b
Restore autoref syntax for links.
Feb 28, 2025
a93a9a9
Replace insert_file functionality with mkdocs-macros' include statement.
Feb 28, 2025
38fcede
Move unused files to extra folder.
Feb 28, 2025
0030d1d
Add (draft) version of csv_table and member_table functions.
Feb 28, 2025
0c001f4
Update syntax for (most) member tables.
Mar 3, 2025
d8c749f
Update syntax for tables missing one of the five member_table keys.
Mar 3, 2025
e4482db
Fix previously broken link.
Mar 3, 2025
6e4a0fe
Update syntax for (most) csv tables.
Mar 3, 2025
91387fd
Remove inner quotations for csv_table string.
Mar 3, 2025
f78c21d
Avoid adding sort buttons for tables with only two rows.
Mar 3, 2025
bd1f460
Add degree symbol for member tables with unit of F (should be degF).
Mar 3, 2025
fbe973f
Use csv_table instead of importing from a file.
Mar 3, 2025
cb15bbe
Add support for csv_table_from_file.
Mar 3, 2025
01e78fb
Refactor main.py to use pathlib.Path instead of os.path.
Mar 3, 2025
36d70f0
Remove backslashes that trigger deprecation warnings (address two of …
Mar 3, 2025
db37d66
Update dependencies.
Mar 3, 2025
2fed8f7
Remove table-reader from mkdocs plugins.
Mar 3, 2025
6d4a1ec
Remove unused f prefix.
Mar 4, 2025
3ad0801
Delete probe-1 junk file.
Apr 29, 2025
09b065f
Add probe definition MD files, other than index.md to gitignore.
Apr 29, 2025
9088778
Add awesome nav to plugins to extract nav properties from mkdocs.yml.
Apr 29, 2025
4b4790d
Update bold headers to use actual md heading notation.
May 1, 2025
f8aa6dc
Update bold headers to use actual md heading notation.
May 2, 2025
4e8399f
Update bold headers to use actual md heading notation.
May 3, 2025
7fe8cbb
Update bold headers to use actual md heading notation.
May 3, 2025
f285682
Initial commit for hooks, adding a starter version of probes and inje…
May 3, 2025
27d39a7
Rest all markdown, since Prettier reformatted MD in a way that broke …
May 5, 2025
d4aa30d
Translate existing links to autorefs syntax.
May 5, 2025
d705a65
Clean up old test nav item.
May 5, 2025
285a8ab
Fix image paths.
May 5, 2025
18fdf6a
Restore include syntax (replacing insert_file functionality).
May 5, 2025
13d7746
Restore new syntax for member_tables.
May 5, 2025
4b9e621
Restore csv tables without headers.
May 6, 2025
24f8dd4
Restore csv tables with headers.
May 6, 2025
e57e839
Remove inner quotations for csv_table string.
May 6, 2025
62814f2
Use csv_table instead of importing from a file.
May 6, 2025
4457c63
Update bold headers to use actual md heading notation.
May 6, 2025
83a070e
Update bold headers to use actual md heading notation.
May 6, 2025
51ac3c2
Update bold headers to use actual md heading notation.
May 6, 2025
23f9fcc
Update bold headers to use actual md heading notation.
May 6, 2025
3109e88
Add ability to ignore subheadings. Add "Built-in Functions" to this c…
May 6, 2025
9d53a41
Replace member_table-type pandoc tables with invokations of member_ta…
May 6, 2025
c9cf6b3
Escape double quotes to fix a csv_table.
May 6, 2025
7f20455
Remove pandoc multiline tables from output-reports.
May 7, 2025
247dd57
Remove pandoc multiline tables from towerplant.
May 7, 2025
68acf01
Remove pandoc multiline tables from surface.
May 7, 2025
734c8e9
Fix issues with missing spaces and line breaks on output-reports.
May 7, 2025
e97ce7f
Use csv module to parse csv_string.
May 11, 2025
4372b7a
Replace all pandoc multiline tables with dl or csv_tables in input-st…
May 12, 2025
e7f5228
Add .DS_Store to .gitignore.
Jul 8, 2025
533fad1
Add CNRECS and related parsers and probe-writer.
Jul 8, 2025
8705869
Tweak CNRECS to remove all multiline field definitions (these are not…
Jul 8, 2025
666437c
Delete old comments (e.g., debug print statements).
Jul 11, 2025
defffb2
Remove "from hooks" debug string.
Jul 11, 2025
538ef1f
Remove unused dodo.py file.
Jul 11, 2025
35791c7
Remove unused doit dependency.
Jul 11, 2025
18d4201
Remove unused imports.
Jul 11, 2025
76b6205
Add MD meta and probe anchors.
Jul 11, 2025
c75e9a2
Add record aliases.
Jul 14, 2025
95eb2ae
Fix buildingAzm link.
Jul 14, 2025
fbea04c
Add line break so the docs parser can understand the grouping.
Jul 14, 2025
d5b75df
Wrap system variables in code block to avoid two dollar signs on the …
Jul 14, 2025
3aab012
Fix stacked headings in DESCOND.
Jul 14, 2025
ea2afa1
Update more headings from bold to actual MD headings.
Jul 14, 2025
a452009
Fix misc files with stacked headings.
Jul 14, 2025
2846112
Merge branch 'main' into feature/migrate-to-mkdocs
Jul 15, 2025
f289e0d
Add captions to images.
Jul 15, 2025
791fffd
Replace more bold text with MD headings.
Jul 15, 2025
212a467
Simplify plant stage heading and type definition.
Jul 15, 2025
0cd59c9
Add alias so "TOP" links to "TOP members" heading.
Jul 15, 2025
65568fc
Fix more stacked headings.
Jul 15, 2025
8ff1ee3
Add ability to check which data members do not have a frequency direc…
Jul 15, 2025
54411df
Remove unused comfort model content.
Jul 15, 2025
1fd8684
Update sfInHcFrcCoeffs table with new member_table syntax.
Jul 15, 2025
a21d04f
Remove unused gnFrZn member_table inside not_yet_implemented ternary.
Jul 15, 2025
f360b9e
Remove unused btInitCycles comment regarding fidelity of cycle degrad…
Jul 15, 2025
8df667c
Remove unused elements from hierarchy code block in input-structure.
Jul 15, 2025
8cb9f99
Update README with a draft for the new documentation system.
Jul 15, 2025
45e10ae
Add footer navigation buttons.
Jul 23, 2025
6e15f8e
Fix loop issue by unwatching probe-definitions in on_serve hook.
Jul 23, 2025
a032358
Fix missing "wsShowerCount" heading.
Jul 24, 2025
fa7ac18
Set all images to have a max-width of 50%.
Jul 25, 2025
4e240f0
Fix syntax of name heading.
Jul 25, 2025
6d9b578
Add probes/cullist txt files to .gitignore.
Jul 25, 2025
4cba543
Add first-draft of coverage checker.
Jul 28, 2025
353a71b
Move shared folder into docs folder.
Jul 28, 2025
62b4c8d
Update coverage.py to use command-line arguments for the path to cse …
Jul 28, 2025
b7dba47
Update README.
Jul 28, 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
19 changes: 14 additions & 5 deletions doc/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
build/
output/
node_modules/
config.yaml
erb-out.txt
documentation-coverage-report.txt
package-lock.json

*.egg*/
.doit.*
.pytest_cache/
.vscode/
.venv/
__pycache__/
dist/

**/probe-definitions/*.md
!**/probe-definitions/index.md

probes.txt
cullist.txt

.DS_Store
Loading
Loading