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

Generate API docs from NUnit source code #843

Merged
merged 41 commits into from
Dec 4, 2023
Merged
Changes from 1 commit
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
bf1e68b
Ignore the API directory
SeanKilleen Nov 27, 2023
b0af9fe
Add docfx generation commands
SeanKilleen Nov 27, 2023
eb91aba
Ignore code-output folder
SeanKilleen Nov 27, 2023
a856ea4
Readme instructions for local use
SeanKilleen Nov 27, 2023
b2771e6
wrap
SeanKilleen Nov 27, 2023
21cbf33
Action to get NUnit asset
SeanKilleen Nov 27, 2023
460a85d
unzip and copy
SeanKilleen Nov 27, 2023
e1c0f39
verbose unzip
SeanKilleen Nov 27, 2023
8c83951
unzip into subdir
SeanKilleen Nov 27, 2023
9cb79ef
adjust syntax
SeanKilleen Nov 27, 2023
06f4514
adjust syntax
SeanKilleen Nov 27, 2023
f90b77b
adjust syntax
SeanKilleen Nov 27, 2023
7404c20
more
SeanKilleen Nov 27, 2023
82ca904
more
SeanKilleen Nov 27, 2023
55adbcc
I must be a little sleepy.
SeanKilleen Nov 27, 2023
8402d58
only ignore YML and manifest files
SeanKilleen Nov 27, 2023
23ac78c
Add API index
SeanKilleen Nov 27, 2023
4a1689d
Add API reference to docs index
SeanKilleen Nov 27, 2023
055fc26
Merge branch 'master' into generate-api-docs
SeanKilleen Dec 1, 2023
41c198a
Adjust TOC file
SeanKilleen Dec 1, 2023
882ef33
Remove index (not needed)
SeanKilleen Dec 1, 2023
706aba7
Let's try out previews of the docs, because why not
SeanKilleen Dec 1, 2023
b439e54
limit step to PR only
SeanKilleen Dec 1, 2023
de97572
remove context flag
SeanKilleen Dec 1, 2023
4ed0750
Only clean up on PRs
SeanKilleen Dec 1, 2023
c0d0f1f
Update to use deploy_url
SeanKilleen Dec 1, 2023
3413080
Attempt to add a preview link comment
SeanKilleen Dec 2, 2023
94684d6
quick test of devcontainer script
SeanKilleen Dec 4, 2023
075b151
Let's see.
SeanKilleen Dec 4, 2023
5360de0
Install unzip
SeanKilleen Dec 4, 2023
172d8b8
remove the zip file
SeanKilleen Dec 4, 2023
da215b1
fix directory
SeanKilleen Dec 4, 2023
1699cbf
move instead of copy
SeanKilleen Dec 4, 2023
7976291
Set flag to overwrite
SeanKilleen Dec 4, 2023
3f44efc
back to copy
SeanKilleen Dec 4, 2023
7ba1a79
more
SeanKilleen Dec 4, 2023
2e88579
There we go.
SeanKilleen Dec 4, 2023
7e1d0ab
aliaa
SeanKilleen Dec 4, 2023
2fa2d7f
comments
SeanKilleen Dec 4, 2023
131c7f2
alias
SeanKilleen Dec 4, 2023
90fbc7a
Contributing updates on one-liner commands
SeanKilleen Dec 4, 2023
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
Let's see.
SeanKilleen committed Dec 4, 2023
commit 075b15148571e2114bd8cb61188b3ebf4e20f562
3 changes: 3 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -22,6 +22,7 @@ RUN node -v
RUN npm -v
RUN yarn -v

# This script gets the api-docs from the latest NUnit release
COPY get-nunit-apidocs.sh .
RUN chmod +x get-nunit-apidocs.sh

@@ -33,4 +34,6 @@ RUN echo 'first_workspace=\"$(cd /workspaces && ls | head -1)\"; alias lint="mar
RUN echo 'first_workspace=\"$(cd /workspaces && ls | head -1)\"; alias build="docfx /workspaces/$first_workspace/docs/docfx.json"' >> ~/.bashrc
RUN echo 'first_workspace=\"$(cd /workspaces && ls | head -1)\"; alias serve="docfx /workspaces/$first_workspace/docs/docfx.json --serve"' >> ~/.bashrc
RUN echo 'first_workspace=\"$(cd /workspaces && ls | head -1)\"; alias snippets="dotnet test /workspaces/$first_workspace/docs/snippets/Snippets.sln"' >> ~/.bashrc

# We load the latest NUnit apidocs at start in case they're needed later
RUN echo 'bash /get-nunit-apidocs.sh' >> ~/.bashrc
13 changes: 12 additions & 1 deletion .devcontainer/get-nunit-apidocs.sh
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
echo "SEAN WAS HERE"
echo "SEAN WAS HERE"

NUNIT_VERSION_FOR_API_DOCS="4.0.0"

first_workspace="$(cd /workspaces && ls | head -1)"

wget "https://github.com/nunit/nunit/releases/download/v$NUNIT_VERSION_FOR_API_DOCS/NUnit.Framework-$NUNIT_VERSION_FOR_API_DOCS.zip" -O apidocs.zip


mkdir $first_workspace/code-output
unzip apidocs.zip
cp -r ./apidocs/NUnit.Framework-$NUNIT_VERSION_FOR_API_DOCS/bin/net6.0/* $first_workspace/code-output