Skip to content

Fix documentation generation #416

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Feb 27, 2020
Merged

Fix documentation generation #416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3ca4a73
update docs generation for multiple modules
kmahar Feb 26, 2020
c1916a5
remove from makefile, add to release script
kmahar Feb 26, 2020
f123dc5
add redirect to mongoswift pain page
kmahar Feb 26, 2020
3ec4752
fix path
kmahar Feb 27, 2020
94cb36f
fix case in index.html
kmahar Feb 27, 2020
4d35d31
capitalization in index links
kmahar Feb 27, 2020
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
5 changes: 0 additions & 5 deletions .jazzy.yaml
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion Guides/Development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Documentation comments should generally be complete sentences and should end wit

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.

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`.
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`.

## Linting and Style
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.
Expand Down
4 changes: 0 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,3 @@ clean:
rm -rf MongoSwift.xcodeproj
rm Package.resolved

documentation:
make project
@$(call check_for_gem,jazzy)
jazzy $(DOCSARG)
6 changes: 6 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# mongo-swift-driver Docs

The MongoDB Swift driver contains two modules:

- [MongoSwift](../MongoSwift/index.html), containing an asynchronous API and a BSON library
- [MongoSwiftSync](../MongoSwiftSync/index.html), containing a synchronous wrapper of the API in `MongoSwift`
Loading