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

Add docstrings and doctests #22

Merged
merged 3 commits into from
Feb 10, 2021
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
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
# Files generated by invoking Julia with --code-coverage
*.jl.cov
*.jl.*.cov

# Files generated by invoking Julia with --track-allocation
*.jl.mem

# System-specific files and directories generated by the BinaryProvider and BinDeps packages
# They contain absolute paths specific to the host computer, and so should not be committed
deps/deps.jl
deps/build.log
deps/downloads/
deps/usr/
deps/src/

# Build artifacts for creating documentation generated by the Documenter package
docs/build/
docs/site/

# File generated by Pkg, the package manager, based on a corresponding Project.toml
# It records a fixed state of all packages used by the project. As such, it should not be
# committed for packages, but should be committed for applications that require a static
# environment.
Manifest.toml
10 changes: 2 additions & 8 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,17 @@ os:
- osx
julia:
- 1.0
- 1.3
- 1
- nightly
matrix:
allow_failures:
- julia: nightly
notifications:
email: false

script:
- if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
- if [[ `uname` = "Linux" ]]; then TESTCMD='xvfb-run julia'; else TESTCMD='julia'; fi
- $TESTCMD -e 'using Pkg; Pkg.build(); Pkg.test(coverage=true)'

jobs:
include:
- stage: "Documentation"
julia: 1.3
julia: 1
os: linux
script:
- julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
Graphics.jl is an [abstraction layer](https://en.wikipedia.org/wiki/Abstraction_layer)
for graphical operations in Julia.

[![Graphics](http://pkg.julialang.org/badges/Graphics_1.0.svg)](http://pkg.julialang.org/?pkg=Graphics&ver=1.0)
[![PkgEval](pkgeval-img)](pkgeval-url)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[![PkgEval](pkgeval-img)](pkgeval-url)
[![PkgEval][pkgeval-img]][pkgeval-url]

Terrible! 😭


See the documentation:

[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaGraphics.github.io/Graphics.jl/stable)

[pkgeval-img]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/G/Graphics.svg
[pkgeval-url]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/report.html
6 changes: 5 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ makedocs(
sitename = "Graphics",
format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
modules = [Graphics],
pages = ["index.md", "reference.md"]
pages = ["index.md", "reference.md"],
clean = false,
checkdocs = :exports
)

DocMeta.setdocmeta!(Graphics, :DocTestSetup, :(using Graphics); recursive=true)

deploydocs(
repo = "github.com/JuliaGraphics/Graphics.jl.git"
)
Loading