Skip to content

Commit

Permalink
Documenter (#640)
Browse files Browse the repository at this point in the history
* Renamed doc/ to docs/.

* Updated gitignore with new docs directory (and docs/site).

* Added documenter builds to travis.

* Updated link in README and added latest badge.

* Started restructuring docs directory.

* Renamed all the .rst files to .md.

* Added JuliaStats logo.

* First pass converting the restructured text to markdown.

* Migrated function docs to docstrings for the appropriate types. NOTE: This often required making some default methods which fail if dispatched to.
* Added some missing references when possible.
* Added a few (mostly empty) docstrings on a few undocumented, but exported distributions.
* Fixed a few equation formatting issues (e.g., `FDist`).

* Minor fixes, but some of them are kind of hacks around the documentation system.

* Turned docstring methods into empty methods that won't be dispatched to.

This allows us to have custom docstrings that won't introduce new methods that could change the behaviour.
Reverted changes to testutils.jl

* Fixed bad references in some univariate docstrings.

* A few formatting fixes.

* Proper escaping of all the latex equations to support 0.7.

Looks like the Base.Markdown.MD `doc""" ... """` syntax doesn't play well with escaping latex equations.
The result is poorly formatted equations in documenter, but using normal docstrings works fine.

* Fix a few more missing escapes

* Convert `NoncentralChisq` to normal docstring so that Documenter can render the equations properly.
  • Loading branch information
rofinn authored and andreasnoack committed Jul 20, 2017
1 parent 2c5eb10 commit ebeab79
Show file tree
Hide file tree
Showing 101 changed files with 2,291 additions and 3,373 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
doc/build
docs/build
docs/site
.Rhistory
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ script:
- julia --check-bounds=yes -e 'Pkg.clone(pwd()); Pkg.build("Distributions"); Pkg.test("Distributions"; coverage=true)'
after_success:
- julia -e 'cd(Pkg.dir("Distributions")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(process_folder())'
- julia -e 'Pkg.add("Documenter"); cd(Pkg.dir("Distributions")); include(joinpath("docs", "make.jl"))'
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Distributions.jl

[![Build Status](https://travis-ci.org/JuliaStats/Distributions.jl.svg?branch=master)](https://travis-ci.org/JuliaStats/Distributions.jl)
[![Coverage Status](https://coveralls.io/repos/JuliaStats/Distributions.jl/badge.svg?branch=master)](https://coveralls.io/r/JuliaStats/Distributions.jl?branch=master)

[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaStats.github.io/Distributions.jl/latest/)
[![Distributions](http://pkg.julialang.org/badges/Distributions_0.5.svg)](http://pkg.julialang.org/?pkg=Distributions)
[![Distributions](http://pkg.julialang.org/badges/Distributions_0.6.svg)](http://pkg.julialang.org/?pkg=Distributions)

Expand All @@ -20,5 +20,5 @@ A Julia package for probability distributions and associated functions. Particul

#### Resources

* **Documentation**: <http://distributionsjl.readthedocs.org/en/latest/>
* **Documentation**: <https://JuliaStats.github.io/Distributions.jl/latest/>
* **Release Notes**: <https://github.com/JuliaStats/Distributions.jl/blob/master/NEWS.md>
153 changes: 0 additions & 153 deletions doc/Makefile

This file was deleted.

1 change: 0 additions & 1 deletion doc/README.md

This file was deleted.

55 changes: 0 additions & 55 deletions doc/genrst.jl

This file was deleted.

Loading

0 comments on commit ebeab79

Please sign in to comment.