Merge pull request #4 from cecoeco/main

fixed missing page in docs

docs/genfiles.jl

@@ -1,5 +1,4 @@
-using Documenter, DocumenterMarkdown
-using Literate
+using Documenter, DocumenterMarkdown, Literate
 
 get_example_path(p) = joinpath(@__DIR__, ".", "examples", p)
 OUTPUT = joinpath(@__DIR__, "src", "examples", "generated")

docs/make.jl

@@ -1,15 +1,13 @@
-using Documenter, DocumenterMarkdown
-using HTTR
+using Documenter, DocumenterMarkdown, HTTR
 
 include("genfiles.jl")
 
 DocTestMeta = quote
     using HTTR
 end
-
 DocMeta.setdocmeta!(HTTR, :DocTestSetup, DocTestMeta; recursive=true)
 
-makedocs(
+Documenter.makedocs(
     modules=[HTTR],
     clean=true,
     doctest=false,
@@ -26,12 +24,12 @@ makedocs(
         # :footnote, :meta_block, :missing_docs, :setup_block
     ], 
     checkdocs=:all, 
-    format=Markdown(), 
+    format=DocumenterMarkdown.Markdown(), 
     draft=false,
     build=joinpath(@__DIR__, "docs")
 )
 
-deploydocs(
+Documenter.deploydocs(
     devurl="latest", 
     repo="https://github.com/TidierOrg/HTTR.jl", 
     push_preview=true,
@@ -48,7 +46,7 @@ deploydocs(
         "jinja2", 
         "mkdocs-video"
     ),
-    make=() -> run(`mkdocs build`), 
+    make=() -> Base.run(`mkdocs build`), 
     target="site", 
     devbranch="main"
 )

docs/mkdocs.yml

@@ -1,7 +1,6 @@
-
 theme:
   name: material
-  logo: assets/logo.png
+  #logo: assets/logo.png
   features:
     - content.code.copy
     # - announce.dismiss
@@ -31,7 +30,7 @@ theme:
     - media: "(prefers-color-scheme: light)"
       scheme: default
       primary: crimson
-      accent: cyan
+      accent: teal
       toggle:
         icon: material/weather-sunny
         name: Switch to dark mode
@@ -40,7 +39,7 @@ theme:
     - media: "(prefers-color-scheme: dark)"
       scheme: slate
       primary: crimson
-      accent: cyan
+      accent: teal
       toggle:
         icon: material/weather-night
         name: Switch to light mode
@@ -82,6 +81,11 @@ extra_css:
   - stylesheets/custom.css
   - assets/Documenter.css
 
+extra_javascript:
+  - javascripts/mathjax.js
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+
 markdown_extensions:
   - tables
   - admonition
@@ -111,4 +115,5 @@ plugins:
 #  - mknotebooks # Jupyter notebooks
   #- mkdocs-video
 nav:
-  - "Home": "index.md"
+  - "Home": "index.md"
+  - "Reference" : "reference.md"

docs/src/reference.md

@@ -0,0 +1,22 @@
+```@meta
+DocTestSetup = quote
+using HTTR
+end
+```
+## Index
+```@index
+Modules = [HTTR]
+Private = false
+```
+
+## Reference - Exported functions
+```@autodocs
+Modules = [HTTR]
+Private = false
+```
+
+## Reference - Internal functions
+```@autodocs
+Modules = [HTTR]
+Public = false
+```