Skip to content

Commit

Permalink
Simplify the tutorial and move to quarto. (#158)
Browse files Browse the repository at this point in the history 
* Simplify the tutorial and move to quarto.
* add Conda, fix some typos.
* Fix all links in the docs 🚀
* bump version.

---------

Co-authored-by: Mateusz Baran <[email protected]>
  • Loading branch information
@kellertuer @mateuszbaran
kellertuer and mateuszbaran committed Jul 2, 2023
1 parent 2254fe8 commit de79731
Show file tree
Hide file tree
Showing 17 changed files with 789 additions and 290 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
julia-version: ["1.0", "1.6", "1.8", "~1.9.0-0"]
julia-version: ["1.0", "1.6", "1.9"]
os: [ubuntu-latest, macOS-latest, windows-latest]
exclude:
- os: macOS-latest
Expand Down
49 changes: 38 additions & 11 deletions .github/workflows/documenter.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,48 @@ jobs:
docs:
name: Documentation
runs-on: ubuntu-latest
if: "contains( github.event.pull_request.labels.*.name, 'preview docs') || github.ref == 'refs/heads/master' || contains(github.ref, 'refs/tags/')"
steps:
- uses: actions/checkout@v3
- uses: quarto-dev/quarto-actions/setup@v2
with:
version: 1.3.353
- uses: julia-actions/setup-julia@latest
with:
version: 1.7
- uses: julia-actions/julia-docdeploy@v1
version: 1.9
- name: Julia Cache
uses: julia-actions/cache@v1
- name: Cache Quarto
id: cache-quarto
uses: actions/cache@v3
env:
cache-name: cache-quarto
with:
path: tutorials/_freeze
key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('tutorials/*.qmd') }}
restore-keys: |
${{ runner.os }}-${{ env.cache-name }}-
- name: Cache Documenter
id: cache-documenter
uses: actions/cache@v3
env:
cache-name: cache-documenter
with:
path: docs/src/tutorials
key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('tutorials/*.qmd') }}
restore-keys: |
${{ runner.os }}-${{ env.cache-name }}-
- name: Cache CondaPkg
id: cache-condaPkg
uses: actions/cache@v3
env:
cache-name: cache-condapkg
with:
path: docs/.CondaPkg
key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('docs/CondaPkg.toml') }}
restore-keys: |
${{ runner.os }}-${{ env.cache-name }}-
- name: "Documenter rendering (including Quarto)"
run: "docs/make.jl --quarto"
env:
PYTHON: ""
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
note:
name: "Documentation deployment note."
runs-on: ubuntu-latest
if: "!contains( github.event.pull_request.labels.*.name, 'preview docs')"
steps:
- name: echo instructions
run: echo 'The Documentation is only generated and pushed on a PR if the “preview docs” label is added.'
2 changes: 1 addition & 1 deletion .github/workflows/format.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v3
- uses: julia-actions/setup-julia@v1
with:
version: 1.4
version: 1.9
- name: Install JuliaFormatter and format
run: |
julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ deps/deps.jl

Manifest.toml
docs/build
docs/src/tutorials/*.md
tutorials/_freeze
docs/.CondaPkg
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ManifoldsBase"
uuid = "3362f125-f0bb-47a3-aa74-596ffd7ef2fb"
authors = ["Seth Axen <[email protected]>", "Mateusz Baran <[email protected]>", "Ronny Bergmann <[email protected]>", "Antoine Levitt <[email protected]>"]
version = "0.14.6"
version = "0.14.7"

[deps]
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Expand Down
305 changes: 305 additions & 0 deletions bib/journal-of-the-royal-statistical-society.csl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,305 @@
<?xml version="1.0" encoding="utf-8"?>
<style xmlns="http://purl.org/net/xbiblio/csl" class="in-text" version="1.0" demote-non-dropping-particle="never" default-locale="en-GB">
<info>
<title>Journal of the Royal Statistical Society</title>
<title-short>JRSS</title-short>
<id>http://www.zotero.org/styles/journal-of-the-royal-statistical-society</id>
<link href="http://www.zotero.org/styles/journal-of-the-royal-statistical-society" rel="self"/>
<link href="http://www.zotero.org/styles/sage-harvard" rel="template"/>
<link href="https://rss.onlinelibrary.wiley.com/hub/journal/1467985x/author-guidelines" rel="documentation"/>
<link href="https://wol-prod-cdn.literatumonline.com/pb-assets/hub-assets/rss/Notes_for_Authors_2019-1552404816963.pdf" rel="documentation"/>
<author>
<name>Patrick O'Brien</name>
</author>
<category citation-format="author-date"/>
<category field="math"/>
<issn>0964-1998</issn>
<eissn>1467-985X</eissn>
<updated>2019-08-24T04:25:28+00:00</updated>
<rights license="http://creativecommons.org/licenses/by-sa/3.0/">This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 License</rights>
</info>
<locale xml:lang="en-GB">
<terms>
<term name="editor" form="short">
<single>ed.</single>
<multiple>eds</multiple>
</term>
</terms>
</locale>
<macro name="editor">
<names variable="editor" delimiter=", ">
<label form="short"/>
<name prefix=" " and="text" initialize-with=". "/>
</names>
</macro>
<macro name="proceedings-editor">
<names variable="editor" delimiter=", " prefix="(" suffix=")">
<label form="short" suffix=" "/>
<name and="text" initialize-with="" delimiter=", " sort-separator=" "/>
</names>
</macro>
<macro name="author">
<names variable="author">
<name and="text" delimiter-precedes-last="never" initialize-with=". " name-as-sort-order="all"/>
<label form="short" prefix=" (" suffix=")"/>
<substitute>
<names variable="editor"/>
<names variable="translator"/>
<text variable="container-title" font-style="italic"/>
<text macro="title"/>
</substitute>
</names>
</macro>
<macro name="author-count">
<names variable="author">
<name form="count"/>
<substitute>
<names variable="editor"/>
</substitute>
</names>
</macro>
<macro name="author-short">
<names variable="author">
<name form="short" and="text" delimiter=", " delimiter-precedes-last="never" initialize-with=""/>
<et-al font-style="italic"/>
<substitute>
<names variable="editor"/>
<names variable="translator"/>
<text variable="container-title" font-style="italic"/>
<text macro="title"/>
</substitute>
</names>
</macro>
<macro name="access">
<choose>
<if variable="DOI">
<text variable="DOI" prefix="DOI: "/>
</if>
<else-if variable="URL">
<text value="Available at: "/>
<text variable="URL"/>
<group prefix=" (" delimiter=" " suffix=")">
<text term="accessed"/>
<date variable="accessed">
<date-part name="day" suffix=" "/>
<date-part name="month" suffix=" "/>
<date-part name="year"/>
</date>
</group>
</else-if>
</choose>
</macro>
<macro name="title">
<choose>
<if type="book">
<text variable="title" font-style="italic" text-case="title"/>
</if>
<else-if type="bill graphic legal_case motion_picture report song thesis" match="any">
<text variable="title" font-style="italic"/>
</else-if>
<else>
<text variable="title"/>
</else>
</choose>
</macro>
<macro name="publisher">
<choose>
<if type="thesis" match="any">
<group delimiter=", ">
<text variable="publisher"/>
<text variable="publisher-place"/>
</group>
</if>
<else-if type="paper-conference" match="any">
<text variable="publisher"/>
</else-if>
<else>
<group delimiter=": ">
<text variable="publisher-place"/>
<text variable="publisher"/>
</group>
</else>
</choose>
</macro>
<macro name="year-date">
<choose>
<if variable="issued">
<date variable="issued">
<date-part name="year"/>
</date>
</if>
<else>
<text term="no date" form="short"/>
</else>
</choose>
</macro>
<macro name="locator">
<choose>
<if type="article-journal">
<text variable="volume" font-weight="bold"/>
<text macro="pages"/>
</if>
</choose>
</macro>
<macro name="published-date">
<choose>
<if type="report" match="any">
<date variable="issued">
<date-part name="day" suffix=" "/>
<date-part name="month" form="long"/>
</date>
</if>
</choose>
</macro>
<macro name="genre">
<choose>
<if type="webpage post-weblog" match="none">
<text variable="genre"/>
</if>
</choose>
</macro>
<macro name="pages">
<choose>
<if type="chapter" match="any">
<group delimiter=" ">
<label variable="page" form="short"/>
<text variable="page"/>
</group>
</if>
<else-if type="article-journal">
<text variable="page" prefix=", "/>
</else-if>
</choose>
</macro>
<macro name="edition">
<choose>
<if is-numeric="edition">
<group delimiter=" ">
<number variable="edition" form="ordinal"/>
<text term="edition" form="short"/>
</group>
</if>
<else>
<text variable="edition" suffix="."/>
</else>
</choose>
</macro>
<macro name="container-details">
<choose>
<if type="chapter post-weblog post" match="any">
<group delimiter=", ">
<group delimiter=" ">
<text term="in" text-case="capitalize-first"/>
<choose>
<if type="chapter">
<text variable="container-title" font-style="italic" text-case="title"/>
</if>
<else>
<text variable="container-title" font-style="italic"/>
</else>
</choose>
<text macro="editor" prefix="(" suffix=")"/>
</group>
<text macro="pages"/>
</group>
</if>
<else-if type="paper-conference" match="any">
<group delimiter=", " prefix="In: ">
<group delimiter=" ">
<choose>
<if variable="container-title">
<text variable="container-title" font-style="italic"/>
</if>
<else>
<text variable="event" font-style="italic"/>
</else>
</choose>
<text macro="proceedings-editor"/>
</group>
<text variable="publisher-place"/>
<date variable="issued">
<date-part name="day" suffix=" "/>
<date-part name="month" form="long" suffix=" "/>
<date-part name="year"/>
</date>
<group delimiter=" ">
<label variable="page" form="short"/>
<text variable="page"/>
</group>
</group>
</else-if>
<else-if type="webpage" match="none">
<group delimiter=", ">
<group delimiter=" ">
<text macro="editor"/>
<text variable="container-title" form="short" font-style="italic"/>
</group>
<choose>
<if type="article-newspaper article-magazine" match="any">
<date variable="issued">
<date-part name="day" suffix=" "/>
<date-part name="month" form="long"/>
</date>
</if>
</choose>
</group>
</else-if>
</choose>
</macro>
<citation et-al-min="3" et-al-use-first="1" disambiguate-add-year-suffix="true" disambiguate-add-names="true" disambiguate-add-givenname="true" collapse="year">
<sort>
<key macro="author-short"/>
<key macro="year-date"/>
<key variable="title"/>
</sort>
<layout prefix="(" suffix=")" delimiter="; ">
<group delimiter=", ">
<text macro="author-short"/>
<text macro="year-date"/>
</group>
</layout>
</citation>
<bibliography hanging-indent="true" et-al-min="4" et-al-use-first="3">
<sort>
<key macro="author" names-min="1" names-use-first="1"/>
<key macro="author-count" names-min="3" names-use-first="3"/>
<key macro="author" names-min="3" names-use-first="1"/>
<key macro="year-date"/>
<key variable="title"/>
</sort>
<layout suffix=".">
<group delimiter=" ">
<text macro="author"/>
<text macro="year-date" prefix="(" suffix=")"/>
<text macro="title" suffix="."/>
<choose>
<if variable="container-title" match="none">
<text macro="edition"/>
</if>
</choose>
<group delimiter=". ">
<group delimiter=", ">
<text macro="container-details"/>
<text macro="locator"/>
</group>
<choose>
<if variable="container-title" match="any">
<text macro="edition"/>
</if>
</choose>
<group delimiter=", ">
<group delimiter=" ">
<text variable="collection-title"/>
<text variable="collection-number"/>
<text variable="number"/>
</group>
<text macro="genre"/>
<text macro="published-date"/>
</group>
<text macro="publisher"/>
</group>
</group>
<text macro="access" prefix=". "/>
</layout>
</bibliography>
</style>
Loading

2 comments on commit de79731

@kellertuer
Copy link
Member Author

Choose a reason for hiding this comment

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

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/86709

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.14.7 -m "<description of version>" de79731c5e323c595db42b17562a6c90da3574b3
git push origin v0.14.7

Please sign in to comment.