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

[dotnet] Fix API docs static generation #14651

Merged
merged 7 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion dotnet/docs/api/index.md

This file was deleted.

54 changes: 33 additions & 21 deletions dotnet/docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,40 @@
{
"src": [
{
"src": "../src/webdriver",
"files": [
"src/webdriver/WebDriver.csproj",
"src/support/WebDriver.Support.csproj",
"bin/**/*.dll"
],
"src": "../"
"**/*.csproj"
]
}
],
"dest": "api",
"includePrivateMembers": false,
"disableGitFeatures": false,
"disableDefaultFilter": false,
"noRestore": false,
"namespaceLayout": "flattened",
"memberLayout": "samePage",
"allowCompilationErrors": false
"dest": "webdriver",
"namespaceLayout": "nested",
"outputFormat": "apiPage"
},
{
"src": [
{
"src": "../src/support",
"files": [
"**/*.csproj"
]
}
],
"dest": "support",
"namespaceLayout": "nested",
"outputFormat": "apiPage"
}

],
"build": {
"content": [
{
"files": "**/*.{md|yml}",
"src": "api"
"files": [
"**/*.{md,yml}"
],
"exclude": [
"_site/**"
]
}
],
"resource": [
Expand All @@ -35,15 +46,16 @@
]
}
],
"dest": "../../build/docs/api/dotnet",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"output": "../../build/docs/api/dotnet",
"template": [
"default",
"modern"
],
"postProcessors": [],
"keepFileLink": false,
"disableGitFeatures": false
"globalMetadata": {
"_appName": "Selenium .NET API",
"_appLogoPath": "images/logo.svg",
"_appFaviconPath": "images/favicon.ico",
"_enableSearch": true
}
}
}
Binary file added dotnet/docs/images/favicon.ico
Binary file not shown.
1 change: 1 addition & 0 deletions dotnet/docs/images/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions dotnet/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: landingPage
---

# Welcome to the Selenium .NET API Docs

## Modules
- [Selenium.WebDriver](/webdriver/OpenQA.Selenium.html)
- [Selenium.Support](/support/OpenQA.Selenium.Support.html)
File renamed without changes.
9 changes: 9 additions & 0 deletions dotnet/docs/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
- name: Intro
href: index.md

- name: Modules
items:
- name: WebDriver
href: webdriver/OpenQA.Selenium.yml
- name: Support
href: support/OpenQA.Selenium.Support.yml
5 changes: 5 additions & 0 deletions dotnet/docs/webdriver/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
###############
# temp file #
###############
*.yml
.manifest
Loading