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 docfx website for documentation #51

Open
wants to merge 27 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
e5eb7ce
move source code to src folder
banchan86 Dec 31, 2024
e1a4f8c
Move editorconfig to src folder
banchan86 Dec 31, 2024
a1bd3ba
Install docfx
banchan86 Dec 31, 2024
ed5906c
Add doc files
banchan86 Dec 31, 2024
4426a72
Add enumSortOrder and memberLayout to docfx.json
banchan86 Dec 31, 2024
1e40744
Add api folder gitignore
banchan86 Dec 31, 2024
06e94b6
Add docfx-tools submodule
banchan86 Dec 31, 2024
039c23c
Fix dotnet.yml for CI
banchan86 Dec 31, 2024
9d93c91
Additional fix for dotnet.yml
banchan86 Dec 31, 2024
ffc6d5d
Remove TOC references to non-existing articles
banchan86 Jan 3, 2025
dbba4c7
Move src back to root dir and modify doc config
banchan86 Jan 3, 2025
e6ab5ab
Apply suggestions from code review
banchan86 Jan 7, 2025
c4f5012
Update docfx-tools submodule
banchan86 Jan 23, 2025
cbae45d
Remove unnecessary docfx.json properties
banchan86 Jan 23, 2025
cc13e91
Add docs.yml GitHub Actions recipe
banchan86 Jan 23, 2025
f24dd2c
Add common build props, ignore artifacts folder
banchan86 Jan 24, 2025
c8c4a48
Add common build props to sln using visual studio
banchan86 Jan 24, 2025
ccf7c2b
Update .csproj with leftover tags from directory.build.props
banchan86 Jan 24, 2025
903a60e
Remove unused declarations in .gitignore
banchan86 Jan 24, 2025
b41004e
Remove year from license file
banchan86 Jan 24, 2025
aee8977
add global.json
banchan86 Jan 24, 2025
ae8aac5
Remove bonsai.props and references to it
banchan86 Jan 24, 2025
ab1d154
Remove unnecessary properties from csproj
banchan86 Jan 24, 2025
707df65
remove git repository information from csproj
banchan86 Jan 24, 2025
74d7168
Update .NET version for dotnet.yml
banchan86 Jan 24, 2025
52c722a
Remove global.json, restore original dotnet.yml
banchan86 Jan 24, 2025
b425cb0
Add bonsai local env
banchan86 Jan 24, 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
13 changes: 13 additions & 0 deletions .config/dotnet-tools.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"version": 1,
"isRoot": true,
"tools": {
"docfx": {
"version": "2.78.2",
"commands": [
"docfx"
],
"rollForward": false
}
}
}
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs/bonsai"]
path = docs/bonsai
url = https://github.com/bonsai-rx/docfx-tools
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_site
2 changes: 2 additions & 0 deletions docs/api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.yml
.manifest
1 change: 1 addition & 0 deletions docs/articles/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- href: ../index.md
1 change: 1 addition & 0 deletions docs/bonsai
Submodule bonsai added at 14246d
2 changes: 2 additions & 0 deletions docs/build.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.\bonsai\modules\Export-Image.ps1 "..\Bonsai.Sgen\bin\Release\net6.0"
dotnet docfx @args
77 changes: 77 additions & 0 deletions docs/docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
{
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
"metadata": [
{
"src": [
{
"src": "../",
"files": [
"**/*.csproj"
]
}
],
"dest": "api",
"filter": "filter.yml",
"enumSortOrder": "declaringOrder",
"memberLayout": "separatePages"
}
],
"build": {
"content": [
{
"files": [
"**/*.{md,yml}"
],
"exclude": [
"_site/**",
"filter.yml",
"apidoc/**"
]
}
],
"resource": [
{
"files": [
"logo.svg",
"favicon.ico",
"images/**",
"workflows/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"output": "_site",
"template": [
"default",
"modern",
"bonsai/template",
"template"
],
"globalMetadata": {
"_appName": "Bonsai - SGEN",
"_appTitle": "Bonsai.SGEN",
"_appFooter": "&copy; 2025 Bonsai Foundation CIC and Contributors. Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a>",
"_enableSearch": true,
"pdf": false
},
"markdownEngineProperties": {
"markdigExtensions": [
"attributes",
"customcontainers"
]
},
"xref": [
"https://bonsai-rx.org/docs/xrefmap.yml"
]
}
}
Binary file added docs/favicon.ico
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/filter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
apiRules:
- exclude:
hasAttribute:
uid: System.ObsoleteAttribute
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
uid: intro
title: "Introduction"
---
96 changes: 96 additions & 0 deletions docs/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/template/public/main.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@import "workflow.css";
13 changes: 13 additions & 0 deletions docs/template/public/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import WorkflowContainer from "./workflow.js"

export default {
defaultTheme: 'auto',
iconLinks: [{
icon: 'github',
href: 'https://github.com/bonsai-rx/sgen',
title: 'GitHub'
}],
start: () => {
WorkflowContainer.init();
}
}
4 changes: 4 additions & 0 deletions docs/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- name: Docs
href: articles/
- name: API
href: api/
2 changes: 2 additions & 0 deletions docs/workflows/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.layout
*.svg
Loading