Skip to content

Commit

Permalink
Edit docs (#13)
Browse files Browse the repository at this point in the history
* Edit docs

* Apply suggestions from code review

* Fix lint

* Update docs/src/contributing.md

Co-authored-by: Lauren Clisby <lclisby@gmail.com>

* Add links to README.md

* Change make.jl

---------

Co-authored-by: Abel Soares Siqueira <nepper271@gmail.com>
Co-authored-by: Lauren Clisby <lclisby@gmail.com>
  • Loading branch information
3 people authored Feb 20, 2024
1 parent 00be448 commit b9c2f21
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 148 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ If you use TulipaPlots.jl in your work, please cite using the reference given in

## Contributing

If you want to make contributions of any kind, please first that a look into our [contributing guide directly on GitHub](docs/src/contributing.md) or the [contributing page on the website](https://TulipaEnergy.github.io/TulipaPlots.jl/dev/contributing/).
We follow the same guidelines as on our main repository, [TulipaEnergyModel](https://github.com/TulipaEnergy/TulipaEnergyModel.jl).
Please read these guidelines [CONTRIBUTING.md](https://github.com/TulipaEnergy/TulipaEnergyModel.jl/blob/main/CONTRIBUTING.md) and our [README.dev](https://github.com/TulipaEnergy/TulipaEnergyModel.jl/blob/main/README.dev.md) to get you started.

---

Expand Down
8 changes: 1 addition & 7 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,7 @@ makedocs(;
canonical = "https://TulipaEnergy.github.io/TulipaPlots.jl",
assets = ["assets/style.css"],
),
pages = [
"Home" => "index.md",
"Example" => "example.md",
"Contributing" => "contributing.md",
"Dev setup" => "developer.md",
"Reference" => "reference.md",
],
pages = ["Home" => "index.md", "Example" => "example.md", "Reference" => "reference.md"],
)

deploydocs(; repo = "github.com/TulipaEnergy/TulipaPlots.jl", push_preview = true)
26 changes: 0 additions & 26 deletions docs/src/contributing.md

This file was deleted.

114 changes: 0 additions & 114 deletions docs/src/developer.md

This file was deleted.

0 comments on commit b9c2f21

Please sign in to comment.