Add API documentation for supported operations (#610)

jump-dev · Jun 5, 2024 · 701d504 · 701d504
1 parent 459f86b
commit 701d504
Show file tree

Hide file tree

Showing 59 changed files with 3,073 additions and 641 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -122,7 +122,7 @@ Documenter.makedocs(
             "developer/contributing.md",
             "developer/credits.md",
         ],
-        "reference.md",
+        "API Reference" => ["reference/api.md", "reference/atoms.md"],
         "release_notes.md",
     ],
 )

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -21,7 +21,7 @@ There are a few ways to get started with Convex:
 
  * Read the [Installation](@ref) guide
  * Read the introductory tutorial [Quick Tutorial](@ref)
- * Read the list of [Supported Operations](@ref)
+ * Read the list of [Supported operations](@ref)
  * Browse some of our examples
 
 !!! tip

diff --git a/docs/src/manual/types.md b/docs/src/manual/types.md
@@ -52,7 +52,7 @@ in a Convex.jl expression.
 Expressions in Convex.jl are formed by applying any *atom* (mathematical
 function defined in Convex.jl) to variables, constants, and other
 expressions. For a list of these functions, see
-[Supported Operations](@ref). Atoms are applied to expressions using
+[Supported operations](@ref). Atoms are applied to expressions using
 operator overloading. For example, `2+2` calls Julia's built-in
 addition operator, while `2+x` calls the Convex.jl addition method and
 returns a Convex.jl expression. Many of the useful language features in

diff --git a/docs/src/reference.md → docs/src/reference/api.md b/docs/src/reference.md → docs/src/reference/api.md
@@ -1,4 +1,8 @@
-# Reference
+# API
+
+!!! info
+    See [Supported operations](@ref) for a list of the operations supported by
+    Convex.
 
 ```@docs
 Convex.AbstractVariable
@@ -8,7 +12,7 @@ Convex.get_constraints
 Convex.add_constraint!
 Convex.vexity
 Convex.vexity!
-Convex.sign
+Base.sign(x::Convex.AbstractVariable)
 Convex.sign!
 Convex.VarType
 Convex.vartype
@@ -26,4 +30,5 @@ Convex.ProblemDepot.foreach_problem
 Convex.ProblemDepot.PROBLEMS
 Convex.conic_form!
 Convex.new_conic_form!
+Convex.write_to_file
 ```