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 script to automatically configure docfx.json #11

Closed
wants to merge 36 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
517c62b
initial draft of export xref script (only extracts operator names, na…
banchan86 Apr 3, 2024
5cd752d
added draft of copy-files function
banchan86 Apr 22, 2024
92cdb7e
updated copy-file function to add .gitignore file to docs/api folder
banchan86 Apr 22, 2024
4beb3a3
updated copy-file script for .bonsai env
banchan86 Apr 23, 2024
c6a44db
forgot to add actual .bonsai env
banchan86 Apr 23, 2024
8389c56
added .github to copy-files script, added additional comments to indi…
banchan86 Apr 23, 2024
295398b
added template folder and build.ps1 to copy files script
banchan86 Apr 23, 2024
685d774
added section to make folders in copy-files
banchan86 Apr 23, 2024
7624da2
corrected spelling mistake in function to make docs_articles_dir
banchan86 Apr 23, 2024
884c5ce
added workflows folder to copy to copy-files
banchan86 Apr 23, 2024
781a7c0
added make images folder to copy-files script
banchan86 Apr 23, 2024
f1b5c97
added Configure-Json script
banchan86 Apr 26, 2024
211048f
updated configure-json script with xref and markdig extensions attrib…
banchan86 Apr 26, 2024
a6a7c5e
fix to configure-json script to address markdig extensions not working
banchan86 Apr 26, 2024
3434b4d
added filter.yml and template attributes and modified docfx.json outp…
banchan86 Apr 27, 2024
629eb46
added appfooter, git contribute attributes to configure-json script
banchan86 Apr 27, 2024
b70724c
remaining attributes app name and title added to configure-json, clea…
banchan86 Apr 28, 2024
28b57f4
bug fixes to configure-json
banchan86 Apr 28, 2024
ab9fee1
bug fixes to overwrite section of configure-json
banchan86 Apr 28, 2024
619f6b1
bug fixes to list extend functions in configure-json
banchan86 Apr 28, 2024
7e183c7
additional bug fixes to list extend functions in configure-json
banchan86 Apr 28, 2024
c6bb339
added filter.yml and rearranged sections in copy-files
banchan86 Apr 28, 2024
8ddb45c
added favicon and logo.svg, started code to modify package specific s…
banchan86 Apr 28, 2024
b99876c
added replacement of package location and github link in build.ps1 an…
banchan86 Apr 28, 2024
8ee007b
added replacement of src sln file in github actions workflows
banchan86 Apr 28, 2024
79cedf3
updated readme.md to document the new configure json and copy files s…
banchan86 Apr 30, 2024
ff87214
Merge branch 'bonsai-rx:main' into main
banchan86 Jun 14, 2024
a1768e3
add export-individual-node-workflow script for API docs
banchan86 Jul 11, 2024
f55833d
Separate configure-json script from the rest
banchan86 Sep 16, 2024
aacdb5e
Convert script from .ipynb to .py, update README
banchan86 Sep 16, 2024
0927f52
Remove package name attribute
banchan86 Sep 16, 2024
2cb062d
Remove reactive xrefmap
banchan86 Sep 16, 2024
fcd5beb
Update docfx.json check error
banchan86 Sep 17, 2024
cf42da9
Refactor and add checks
banchan86 Sep 17, 2024
aa59e64
Refactor code, add checks, trim options
banchan86 Sep 17, 2024
c728af1
Exclude apidoc from build to avoid DuplicateUid
banchan86 Sep 18, 2024
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
updated configure-json script with xref and markdig extensions attrib…
…utes
banchan86 committed Apr 26, 2024
commit 211048ffb9f0c229c0ce009c08b7e1b09ec71827
46 changes: 44 additions & 2 deletions modules/Configure-Json.ipynb
Original file line number Diff line number Diff line change
@@ -32,9 +32,51 @@
"try:\n",
" with open(os.path.join(docs_dir, \"docfx.json\"), 'r') as file:\n",
" data = json.load(file)\n",
" print(data)\n",
"except FileNotFoundError:\n",
" print(\"docfx.json not file, run docfx first to create docfx file\")"
" print(\"docfx.json not file, run docfx first to create docfx.json file\")"
]
},
{
"cell_type": "code",
"execution_count": 4,
"metadata": {},
"outputs": [
{
"ename": "NameError",
"evalue": "name 'data' is not defined",
"output_type": "error",
"traceback": [
"\u001b[1;31m---------------------------------------------------------------------------\u001b[0m",
"\u001b[1;31mNameError\u001b[0m Traceback (most recent call last)",
"Cell \u001b[1;32mIn[4], line 1\u001b[0m\n\u001b[1;32m----> 1\u001b[0m data[\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mbuild\u001b[39m\u001b[38;5;124m\"\u001b[39m][\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mmarkdownEngineProperties\u001b[39m\u001b[38;5;124m\"\u001b[39m][\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mmarkdigExtensions\u001b[39m\u001b[38;5;124m\"\u001b[39m] \u001b[38;5;241m=\u001b[39m [\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mattributes\u001b[39m\u001b[38;5;124m\"\u001b[39m,\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mcustomcontainers\u001b[39m\u001b[38;5;124m\"\u001b[39m]\n",
"\u001b[1;31mNameError\u001b[0m: name 'data' is not defined"
]
}
],
"source": [
"# adds markdig extensions\n",
"data[\"build\"][\"markdownEngineProperties\"][\"markdigExtensions\"] = [\"attributes\",\"customcontainers\"]"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"# adds xref \n",
"data[\"build\"][\"xref\"] = [\"https://bonsai-rx.org/docs/xrefmap.yml\",\"https://horizongir.github.io/reactive/xrefmap.yml\"]"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"# write json file\n",
"with open(os.path.join(docs_dir, \"docfx.json\"), 'w') as file:\n",
" json.dump(data, file, indent=4)\n"
]
}
],