Skip to content

Commit cc89206

Browse files
authored
Fix documentation generation (#416)
1 parent 7fb3fc0 commit cc89206

File tree

7 files changed

+40
-631
lines changed

7 files changed

+40
-631
lines changed

.jazzy.yaml

Lines changed: 0 additions & 5 deletions
This file was deleted.

Guides/Development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Documentation comments should generally be complete sentences and should end wit
7070

7171
Our documentation site is automatically generated from the source code using [Jazzy](https://github.com/realm/jazzy#installation). We regenerate it via our release script each time we release a new version of the driver.
7272

73-
If you'd like to preview how new documentation you've written will look when published, you can regenerate it by running `make documentation` and then inspecting the generated HTML files in `/docs`.
73+
If you'd like to preview how new documentation you've written will look when published, you can regenerate it by running `./etc/generate-docs.sh` and then inspecting the generated HTML files in `/docs`.
7474

7575
## Linting and Style
7676
We use [SwiftLint](https://github.com/realm/SwiftLint#using-homebrew) for linting. You can see our configuration in the `.swiftlint.yml` file in the project's root directory. Run `swiftlint` in the root directory to lint all of our files. Running `swiftlint autocorrect` will correct some types of violations.

Makefile

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,3 @@ clean:
5656
rm -rf MongoSwift.xcodeproj
5757
rm Package.resolved
5858

59-
documentation:
60-
make project
61-
@$(call check_for_gem,jazzy)
62-
jazzy $(DOCSARG)

docs/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# mongo-swift-driver Docs
2+
3+
The MongoDB Swift driver contains two modules:
4+
5+
- [MongoSwift](../MongoSwift/index.html), containing an asynchronous API and a BSON library
6+
- [MongoSwiftSync](../MongoSwiftSync/index.html), containing a synchronous wrapper of the API in `MongoSwift`

0 commit comments

Comments
 (0)