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

Initial setup of docs #51

Merged
merged 24 commits into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
6dbbd78
Update Documenter (and GCPDecompositions)
dahong67 Mar 6, 2024
7cd7a9b
Include all modules so that docs build
dahong67 Mar 6, 2024
da4528e
Drop docs part of CI.yml workflow
dahong67 Mar 6, 2024
c3fafa3
Simplify/revise `docs/make.jl`
dahong67 Mar 7, 2024
45ffa17
Move API to separate page
dahong67 Mar 7, 2024
a70e3a1
Drop meta block that does not seem needed
dahong67 Mar 7, 2024
5d39775
Split apart docstrings
dahong67 Mar 7, 2024
993042d
Split API into separate manual pages
dahong67 Mar 7, 2024
b3131f7
Rename main page to overview
dahong67 Mar 7, 2024
8e3efe8
Add stubs for quick start guide and demos
dahong67 Mar 7, 2024
679ba15
Update docs CI, switch to using Julia 1.10 and update
dahong67 Mar 21, 2024
d58f50c
Hide demo pages for now
dahong67 Mar 21, 2024
397ab36
Commit earlier work on quick start guide
dahong67 Jun 3, 2024
da2e564
Tweaks to quick start guide, demo checking the quality of the factors
dahong67 Jun 3, 2024
8cdf585
Update to Julia 1.10.4
dahong67 Jun 13, 2024
67b750b
Update Documenter
dahong67 Jun 13, 2024
9e0f792
Add LiveServer
dahong67 Jun 13, 2024
c9c6f29
Simplify installation instructions
dahong67 Jun 13, 2024
b341054
Add WIP notes
dahong67 Jun 13, 2024
12c94a7
Rework demo architecture to use Pluto notebooks
dahong67 Jun 14, 2024
fdd20e9
Add other docstrings
dahong67 Jun 14, 2024
6547c1b
Tweak autodoc condition to pass
dahong67 Jun 14, 2024
af7f5d9
Fix autodoc condition
dahong67 Jun 14, 2024
9065895
Swap test demo with new amino acid demo
dahong67 Jun 14, 2024
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
20 changes: 0 additions & 20 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,3 @@ jobs:
- uses: codecov/codecov-action@v2
with:
files: lcov.info
# docs:
# name: Documentation
# runs-on: ubuntu-latest
# permissions:
# contents: write
# steps:
# - uses: actions/checkout@v2
# - uses: julia-actions/setup-julia@v1
# with:
# version: '1'
# - uses: julia-actions/julia-buildpkg@v1
# - uses: julia-actions/julia-docdeploy@v1
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# - run: |
# julia --project=docs -e '
# using Documenter: DocMeta, doctest
# using GCPDecompositions
# DocMeta.setdocmeta!(GCPDecompositions, :DocTestSetup, :(using GCPDecompositions); recursive=true)
# doctest(GCPDecompositions)'
6 changes: 4 additions & 2 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ jobs:
build:
permissions:
contents: write
statuses: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v1
with:
version: '1.6'
version: '1.10'
- uses: julia-actions/cache@v1
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
Expand Down
Loading
Loading