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

Deploy documentation #95

Merged
merged 11 commits into from
Jun 18, 2024
Merged

Deploy documentation #95

merged 11 commits into from
Jun 18, 2024

Conversation

abhro
Copy link
Contributor

@abhro abhro commented Jun 15, 2024

  • Add docstrings
  • Refactor doc pages
  • Enable CI documentation build
  • Tweak doctest setup

@sjkelly
Copy link
Member

sjkelly commented Jun 18, 2024

Looks good! I think I will need to generate a DOCUMENTER_KEY for the CI? I also broke compat bounds on <1.6 I think by adding the stdlibs.

@sjkelly sjkelly merged commit c5d24f9 into JuliaGeometry:master Jun 18, 2024
0 of 10 checks passed
@abhro abhro deleted the doc-deploy branch June 18, 2024 15:22
@timholy
Copy link
Member

timholy commented Jan 8, 2025

@sjkelly, I'd generally prefer to squash PRs like this, unless you thought there was a reason to keep the commits separate.

tim@diva:~/.julia/dev/CoordinateTransformations$ git log
commit 692120de016194c5f4fb43eb2eb801cc57933b40 (HEAD -> master, origin/master, origin/HEAD)
Merge: c5d24f9 8668ea8
Author: Steve Kelly <[email protected]>
Date:   Thu Jun 20 11:38:33 2024 -0400

    Merge pull request #94 from abhro/petite-output

    Make Base.show() output more petite

commit 8668ea8470c57460c35cc0c3ceda23dcff3db190
Merge: 250d3ad c5d24f9
Author: abhro <[email protected]>
Date:   Tue Jun 18 11:23:41 2024 -0400

    Merge branch 'JuliaGeometry:master' into petite-output

commit c5d24f90a408ed29e13c97570d26c310af590968
Merge: a0b7026 73f365c
Author: Steve Kelly <[email protected]>
Date:   Tue Jun 18 09:57:12 2024 -0400

    Merge pull request #95 from abhro/doc-deploy

    Deploy documentation

commit 73f365c9d1c76a6e2654aabdc0b041d680829576
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:27:32 2024 -0400

    Call deploydocs in docs/make.jl

commit 97c5448c2675eec804362cbb24e84c9ce0ff40c9
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:27:19 2024 -0400

    Enable documenter deploy on CI

commit eadcb8cdb4a2382e08956e1b23ace80a0bd9c61d
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:26:51 2024 -0400

    Pull in docs index.md from README.md

commit 2294ce47a2b7270bb3b878db43fb5ec2eb215cc4
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:26:24 2024 -0400

    Manually categorize API reference page

commit 78ef98857e3acd460629f5cc94029e0c0e30773c
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:26:06 2024 -0400

    Add more params to makedocs

commit 250d3ad5e9bde438d55eefa0c136b2443eb71286
Author: abhro <[email protected]>
Date:   Sat Jun 15 16:24:35 2024 -0400

    Make Base.show() output more petite

commit 362168bc9a5814b94e0996dd97972d5122b4c77b
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:23:06 2024 -0400

    Line wrapping

commit 7aab011f48e9b3c1c5bab7d1df83dcf6082b7281
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:21:53 2024 -0400

    Factor out doctest setup code

commit 7c6ca1bf2ef4a1c1d128a3e8bfd02839615c98e8
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:21:08 2024 -0400

    Move hash sign

commit 65ed727a4490a2908cac5af0029df6fbf914923e
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:21:01 2024 -0400

    Add setup code for doctests

commit 2d66c0928b12b3d0c0281667bcac5a1baf55cb1d
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:19:42 2024 -0400

    Add type headers to type docstrings

commit 15270616ed51d416fc801d598edb5357a5e40b63
Author: Abhro R <[email protected]>
Date:   Sat Jun 15 16:17:30 2024 -0400

    Add docstring for AbstractAffineMap

commit a0b702650bc6d81745ac1415028482de4209c6a1
Author: Steve Kelly <[email protected]>
Date:   Fri Jun 14 15:15:42 2024 -0400

    add Aqua and adjust compats

commit df38b65969f20d58f442a37d89758e940a6371f2
Merge: d0c96e0 a13e939
Author: Steve Kelly <[email protected]>
Date:   Thu Jun 13 23:14:39 2024 -0400

    Merge pull request #93 from abhro/docs

    Documentation website and docstrings

commit d0c96e06df7a643a2e5563908a5c002908865841
Author: Steve Kelly <[email protected]>
Date:   Thu Jun 13 23:11:58 2024 -0400

    Update README.md

commit a13e93970f54a04cb8a7f5cf105152dc484432b7
Author: Abhro R <[email protected]>
Date:   Mon May 20 15:46:40 2024 -0400

    Make index.md the introduction page

commit ca387d52b0ae71b7165e3ea9df1b7d07df96d5f8
Author: Abhro R <[email protected]>
Date:   Mon May 20 15:46:24 2024 -0400

    Fix docstrings to work with Documenter.jl

commit 674aa33d29e003206b5f4763567998cc056a4924
Author: Abhro R <[email protected]>
Date:   Mon May 20 15:07:16 2024 -0400

    Add barebones Documenter.jl structure

 ⋮

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants