From 908f3d41c0656873442f72fd5aa7201775692984 Mon Sep 17 00:00:00 2001 From: "Joe(y) Carpinelli" Date: Wed, 1 Jan 2025 01:05:56 -0500 Subject: [PATCH] Removed frontmatter from API reference page --- README.md | 9 ++++++--- docs/src/.gitignore | 3 ++- docs/src/_quarto.yml | 6 ++---- docs/src/api/index.qmd | 12 ++++-------- src/DocumenterQuarto.jl | 2 +- 5 files changed, 15 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 83785be..3a8d7ae 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,12 @@ If you don't already have documentation for your package, use the following step 1. Navigate to the **root directory** of your Julia package. 2. Execute the code below. -``` sh -julia -e 'import Pkg; Pkg.add(url="https://github.com/cadojo/DocumenterQuarto.jl")' -julia -e 'import DocumenterQuarto; DocumenterQuarto.generate()' +``` julia +import Pkg +Pkg.add(url="https://github.com/cadojo/DocumenterQuarto.jl") + +import DocumenterQuarto +DocumenterQuarto.generate() ``` ### Documenting an Existing Package diff --git a/docs/src/.gitignore b/docs/src/.gitignore index 075b254..73f9798 100644 --- a/docs/src/.gitignore +++ b/docs/src/.gitignore @@ -1 +1,2 @@ -/.quarto/ +.quarto +*.quarto_ipynb \ No newline at end of file diff --git a/docs/src/_quarto.yml b/docs/src/_quarto.yml index c57a389..156fae4 100644 --- a/docs/src/_quarto.yml +++ b/docs/src/_quarto.yml @@ -7,20 +7,18 @@ book: author: name: "Joey Carpinelli" email: "joey@loopy.codes" - date: "2024-12-31" + date: "2025-01-02" chapters: - index.md - api/index.qmd - sidebar: - search: true toc-title: "Table of Contents" execute: echo: false output: true - cache: false freeze: false + daemon: 300 bibliography: references.bib diff --git a/docs/src/api/index.qmd b/docs/src/api/index.qmd index aab15c0..9f1d18d 100644 --- a/docs/src/api/index.qmd +++ b/docs/src/api/index.qmd @@ -1,7 +1,3 @@ ---- -number-depth: 2 ---- - # Reference _Docstrings for DocumenterQuarto._ @@ -10,17 +6,17 @@ _Docstrings for DocumenterQuarto._ #| echo: false #| output: false using DocumenterQuarto -using DocumenterQuarto ``` + ```{julia} #| echo: false #| output: asis -DocumenterQuarto.autodoc(DocumenterQuarto) +DocumenterQuarto.doc(DocumenterQuarto.generate) ``` ```{julia} #| echo: false #| output: asis -DocumenterQuarto.doc(DocumenterQuarto.generate) -``` \ No newline at end of file +DocumenterQuarto.autodoc(DocumenterQuarto) +``` diff --git a/src/DocumenterQuarto.jl b/src/DocumenterQuarto.jl index 74f335d..374b2f9 100644 --- a/src/DocumenterQuarto.jl +++ b/src/DocumenterQuarto.jl @@ -254,7 +254,7 @@ function process_headers(markdown) for (index, item) in enumerate(markdown.content) if item isa Markdown.Header newlevel = min(level(item) + 2, 6) - markdown.content[index] = Markdown.Header{newlevel}(item.text * " {.unnumbered}") + markdown.content[index] = Markdown.Header{newlevel}(vcat(item.text, " {.unnumbered}")) elseif :content in propertynames(item) markdown.content[index] = process_headers(item) end