Skip to content

Commit

Permalink
Removed frontmatter from API reference page
Browse files Browse the repository at this point in the history
  • Loading branch information
cadojo committed Jan 3, 2025
1 parent f74a5f7 commit 908f3d4
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 17 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/src/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/.quarto/
.quarto
*.quarto_ipynb
6 changes: 2 additions & 4 deletions docs/src/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,18 @@ book:
author:
name: "Joey Carpinelli"
email: "[email protected]"
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

Expand Down
12 changes: 4 additions & 8 deletions docs/src/api/index.qmd
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
number-depth: 2
---

# Reference

_Docstrings for DocumenterQuarto._
Expand All @@ -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)
```
DocumenterQuarto.autodoc(DocumenterQuarto)
```
2 changes: 1 addition & 1 deletion src/DocumenterQuarto.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 908f3d4

Please sign in to comment.