Skip to content

Add documentation #7

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.

Sign up for GitHub

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

Merged
DimitriAlston merged 3 commits into from
Apr 22, 2026
Merged

Add documentation #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8f0095
Add documentation
DimitriAlston Apr 22, 2026
9dcbe37
Update Project.toml
DimitriAlston Apr 22, 2026
3975aad
Update index.md
DimitriAlston Apr 22, 2026
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
27 changes: 27 additions & 0 deletions .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Documentation

on:
push:
branches: [main]
tags: '*'
pull_request:
types: [opened, synchronize, reopened]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@latest
with:
# Build documentation on Julia 1.10
version: '1.10'
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
# For authentication with GitHub Actions token
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# For authentication with SSH deploy key
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
run: julia --project=docs/ docs/make.jl
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/build
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@

| **PSOR Lab** | **Build Status** |
|:------------:|:-----------------------------------------------------------------------------------------------:|
| [![](https://img.shields.io/badge/Developed_by-PSOR_Lab-342674)](https://psor.uconn.edu/) | [![Build Status](https://github.com/PSORLab/EOptInterface.jl/workflows/CI/badge.svg?branch=main)](https://github.com/PSORLab/EOptInterface.jl/actions?query=workflow%3ACI) [![codecov](https://codecov.io/gh/PSORLab/EOptInterface.jl/graph/badge.svg?token=1x9pOV439N)](https://codecov.io/gh/PSORLab/EOptInterface.jl) |
| [![](https://img.shields.io/badge/Developed_by-PSOR_Lab-342674)](https://psor.uconn.edu/) | [![Build Status](https://github.com/PSORLab/EOptInterface.jl/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/PSORLab/EOptInterface.jl/actions?query=workflow%3ACI) [![codecov](https://codecov.io/gh/PSORLab/EOptInterface.jl/graph/badge.svg?token=1x9pOV439N)](https://codecov.io/gh/PSORLab/EOptInterface.jl) |

<!--
**Documentation** |
:-----------------------------------------------------------------:|
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://PSORLab.github.io/EOptInterface.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://PSORLab.github.io/EOptInterface.jl/dev/) |
-->
| **Documentation** |
|:-----------------------------------------------------------------:|
| [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://PSORLab.github.io/EOptInterface.jl/stable) [![](https://img.shields.io/badge/docs-latest-blue.svg)](https://PSORLab.github.io/EOptInterface.jl/dev) |

## Feature Summary

Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
build/
295 changes: 0 additions & 295 deletions docs/Manifest.toml
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
EOptInterface = "96d9f51d-8c41-4e2d-b1a3-7b48dea3ddd1"

[compat]
Documenter = "1"
Binary file added docs/assets/favicon.ico
View file
Open in desktop
Binary file not shown.
27 changes: 13 additions & 14 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
using EOptInterface
using Documenter

DocMeta.setdocmeta!(EOptInterface, :DocTestSetup, :(using EOptInterface); recursive=true)
using DocumenterTools
using EOptInterface

makedocs(;
modules=[EOptInterface],
authors="Joseph Choi <jsphchoi@mit.edu>",
sitename="EOptInterface.jl",
format=Documenter.HTML(;
canonical="https://PSORLab.github.io/EOptInterface.jl",
edit_link="master",
assets=String[],
modules = [EOptInterface],
authors = "Joseph Choi, Dimitri Alston, Pengfei Xu, and Matthew Stuber",
sitename = "EOptInterface.jl",
format = Documenter.HTML(;
canonical = "https://PSORLab.github.io/EOptInterface.jl/stable",
collapselevel = 1,
assets = ["assets/favicon.ico"],
),
pages=[
"Home" => "index.md",
pages = Any[
"API Reference" => "index.md",
"News" => "news.md",
],
)

deploydocs(;
repo="github.com/PSORLab/EOptInterface.jl",
devbranch="master",
repo = "github.com/PSORLab/EOptInterface.jl",
)
Loading
Loading