Skip to content

Commit

Permalink
t push origin masterMerge branch 'JuliaDocs-master'
Browse files Browse the repository at this point in the history
* JuliaDocs-master: (138 commits)
  Add example admonition css to example build (JuliaDocs#1284)
  Pass non-standard admonition categories on in HTML output (JuliaDocs#1280)
  Suggest using the `aligned` environment (JuliaDocs#1275)
  Update DiffEq docs link (JuliaDocs#1274)
  Make Deps.pip a closure again (JuliaDocs#1240)
  Recommend Julia 1.4 in the manual (JuliaDocs#1272)
  Add note about doctests in docstrings (JuliaDocs#1265)
  Fix minted/lstlistings escaping (JuliaDocs#1269)
  Changelog for 0.24.7 (JuliaDocs#1266)
  Test with Julia 1.4 instead of 1.3 on CI (JuliaDocs#1268)
  Fix doctest testing on nightly (JuliaDocs#1267)
  remove "only" from search stop word filter (JuliaDocs#1264)
  Reorganize some Sass variables to make theming easier (JuliaDocs#1258)
  Fix outdated links in the manual (JuliaDocs#1255)
  Fix LaTeX tests for tags (JuliaDocs#1256)
  Install TagBot as a GitHub Action (JuliaDocs#1237)
  use Julia 1.3 for .travis hosting example (JuliaDocs#1235)
  Set version to 0.24.5 (JuliaDocs#1233)
  Support REPL softscope for Julia 1.5. (JuliaDocs#1232)
  Discourage use of matrix: in Travis conf (JuliaDocs#1231)
  ...
  • Loading branch information
briochemc committed Apr 10, 2020
2 parents b29e029 + e5bb023 commit e52cc0d
Show file tree
Hide file tree
Showing 210 changed files with 29,094 additions and 2,288 deletions.
14 changes: 7 additions & 7 deletions .appveyor.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
environment:
matrix:
- julia_version: 0.7
- julia_version: 1.0
- julia_version: latest
- julia_version: 1.4
- julia_version: nightly

platform:
- x86 # 32-bit
- x64 # 64-bit

## uncomment the following lines to allow failures on nightly julia
## (tests will run but not make your overall status red)
#matrix:
# allow_failures:
# - julia_version: latest
# Uncomment the following lines to allow failures on nightly julia
# (tests will run but not make your overall status red)
matrix:
allow_failures:
- julia_version: nightly

branches:
only:
Expand Down
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
custom: https://numfocus.org/donate-to-julia
11 changes: 11 additions & 0 deletions .github/workflows/TagBot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: TagBot
on:
schedule:
- cron: 0 * * * *
jobs:
TagBot:
runs-on: ubuntu-latest
steps:
- uses: JuliaRegistries/TagBot@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
20 changes: 20 additions & 0 deletions .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Linkcheck

on:
push:
branches: '*'
tags: '*'
pull_request:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@latest
with:
version: '1.4'
- name: Install dependencies
run: julia --color=yes --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and check documentation
run: julia --color=yes --project=docs/ docs/make.jl
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@
*.jl.mem
Manifest.toml

test/doctests/builds/
test/examples/builds/
test/formats/builds/
test/missingdocs/build/
test/nongit/build/
test/errors/build/
test/workdir/builds/
docs/build/
docs/pdf/build/
docs/site/
34 changes: 26 additions & 8 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,40 @@ os:
- osx

julia:
- 0.7
- 1.0
- 1.4
- nightly

notifications:
email: false
branches:
only:
- master
- /^release-.*$/
- /^v\d+\.\d+(\.\d+)?(-\S*)?$/

after_success:
- julia --project=coverage/ -e 'using Pkg; Pkg.instantiate()'
- julia --project=coverage/ coverage/coverage.jl
- if [ -f test/quietly.log ]; then cat test/quietly.log; fi
- if [[ $TRAVIS_JULIA_VERSION = 1.1 ]] && [[ $TRAVIS_OS_NAME = linux ]]; then
julia --project=coverage/ -e 'using Pkg; Pkg.instantiate();
using Coverage; Codecov.submit(Codecov.process_folder())';
fi

jobs:
allow_failures:
- julia: nightly
include:
- stage: "Additional tests"
script:
- julia --project=test/themes -e 'using Pkg; Pkg.instantiate(); Pkg.develop(PackageSpec(path=pwd()))'
- julia --project=test/themes test/themes/themes.jl
name: "Themes"
- script:
- julia --project=test/examples -e 'using Pkg; Pkg.instantiate(); Pkg.develop(PackageSpec(path=pwd())); Pkg.add("DocumenterMarkdown")'
- julia --project=test/examples test/examples/tests_latex.jl
name: "PDF/LaTeX backend"
- stage: "Documentation"
julia: 1.0
os: linux
script:
- julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- julia --project=docs/ docs/make.jl
- julia --project=docs/ docs/make.jl skiplinks
name: "HTML"
after_success: skip
- script:
Expand All @@ -32,3 +47,6 @@ jobs:
name: "PDF"
after_success: skip
services: docker

notifications:
email: false
236 changes: 236 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

16 changes: 10 additions & 6 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -1,25 +1,29 @@
name = "Documenter"
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
version = "0.22.3"
version = "0.24.7+0.25-DEV"

[deps]
Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
LibGit2 = "76f85450-5226-5b5a-8eaa-529ad045b433"
Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
Unicode = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"

[compat]
julia = "0.7, 1"
DocStringExtensions = "0.4, 0.5, 0.6, 0.7"
JSON = "0.19, 0.20"
DocStringExtensions = "0.4, 0.5, 0.6, 0.7, 0.8"
JSON = "0.19, 0.20, 0.21"
julia = "1"

[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
DocumenterMarkdown = "997ab1e6-3595-5248-9280-8efb232c3433"
DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"

[targets]
test = ["Test"]
test = ["Random", "DocumenterMarkdown", "DocumenterTools"]
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,22 @@ julia> import Pkg; Pkg.add("Documenter")

## Project Status

The package is tested against Julia `0.7`, `1.0` and the nightly builds of the Julia `master` branch on Linux, macOS, and Windows.
The package is tested against, and being developed for, Julia `1.0` and above on Linux, macOS, and Windows.

Support for Julia `0.4`, `0.5` and `0.6` has been dropped in the latest version, but older versions of Documenter may still work (Documenter versions `0.8`, `0.11` and `0.19`, respectively).
Support for Julia `0.4`, `0.5`, `0.6` and `0.7` has been dropped in the latest version, but older versions of Documenter may still work (Documenter versions `0.8`, `0.11`, `0.19`, and `0.22` respectively).

## Questions and Contributions

Usage questions can be posted on the [Julia Discourse forum][discourse-tag-url] under the `documenter` tag, in the #documentation channel of the [Julia Slack](https://julialang.org/community/) and/or in the [JuliaDocs Gitter chat room][gitter-url].

Contributions are very welcome, as are feature requests and suggestions. Please open an [issue][issues-url] if you encounter any problems. The [contributing page][contrib-url] has a few guidelines that should be followed when opening pull requests and contributing code.

[contrib-url]: https://juliadocs.github.io/Documenter.jl/latest/man/contributing/
[contrib-url]: https://juliadocs.github.io/Documenter.jl/dev/contributing/
[discourse-tag-url]: https://discourse.julialang.org/tags/documenter
[gitter-url]: https://gitter.im/juliadocs/users

[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
[docs-dev-url]: https://juliadocs.github.io/Documenter.jl/latest
[docs-dev-url]: https://juliadocs.github.io/Documenter.jl/dev

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://juliadocs.github.io/Documenter.jl/stable
Expand Down
11 changes: 11 additions & 0 deletions assets/html/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Non-Julia Assets for `HTMLWriter`

Themes / CSS:

* `scss/`: contains the SCSS and Sass files
* `scss/bulma/`: Sass sources of the [Bulma CSS framework](https://bulma.io/), v0.7.5
(MIT license, [GitHub](https://github.com/jgthms/bulma))
* `darkly/`: [Darkly Bulmaswatch theme](https://jenil.github.io/bulmaswatch/darkly/) (MIT license, [GitHub](https://github.com/jenil/bulmaswatch/))
* `documenter/`: Documenter-specific overrides, components etc.
* `documenter.scss` and `darkly.scss`: Documenter default themes
* `themes/`: contains the compiled `.css` files of the default themes
63 changes: 0 additions & 63 deletions assets/html/arrow.svg

This file was deleted.

Loading

0 comments on commit e52cc0d

Please sign in to comment.