Skip to content

Commit

Permalink
Vitepress documentation! (#59)
Browse files Browse the repository at this point in the history
* Fix minor errors when generating docs

* Switch to DocumenterVitepress for doc build

* Fix `polygonize` returning polygons of indices and not real coordinates

* Fix minor doc errors

* Add GeoInterface-compatible methods for barycentric

* Custom style theme!!

* Revamp intro page

* use experimental branch of DocumenterVitepress

* clean up for DV v0.0.7

* Add a basic CONTRIBUTING.md

* Clean up

* Add CONTRIBUTING.md

* `bools.jl` -> `orientation.jl`

* fix tests
  • Loading branch information
asinghvi17 authored Feb 29, 2024
1 parent ec2cc12 commit a08501f
Show file tree
Hide file tree
Showing 23 changed files with 470 additions and 1,808 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contributing to GeometryOps.jl

Thank you for your interest in contributing to GeometryOps.jl! Here are some guidelines to help you get started.

## Code Organization

- Try to keep each functionality in one file or folder. For example, polygon cutting and intersection are in different files. However, common utilities were moved out to another file, which is also OK. Semantically, each file should have one job.
- We use a [**literate programming**](https://en.wikipedia.org/wiki/Literate_programming) approach. This means that the code and documentation are intertwined, making the code easier to understand. Please follow this style when contributing.
- Please add an example in the comments at the top of each file. This should illustrate how to use the functionality provided by the file. We've found that these examples are incredibly helpful for understanding the code.
- Visual examples using plots (we use Makie in this library) are always helpful, and should go at the top of the file. Each file should have a
- If you are confused, take a look at e.g. `src/methods/distance.jl` or `src/methods/area.jl`, and follow their structure as templates.
- Only functions which the user should access and which promise stability should be exported and documented. By convention, internal functions begin with `_` and generally do not have docstrings (though they should have comments on top in place of that).

## Tests

Tests are great! We love tests. They are organized in the `test` directory in the same structure as the `src` directory. Try and add as many tests as possible, and try for integration tests - especially those with real-world uses!


5 changes: 5 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules/
build/
package-lock.json
src/source/
Manifest.toml
Loading

0 comments on commit a08501f

Please sign in to comment.