Skip to content

Commit

Permalink
docs: add quartodoc for api referencec
Browse files Browse the repository at this point in the history
  • Loading branch information
SaaiVenkat committed May 9, 2024
1 parent 6e6d679 commit f3293ba
Show file tree
Hide file tree
Showing 7 changed files with 76 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -171,3 +171,5 @@ cython_debug/
.idea/

.DS_Store

/.quarto/
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.quarto/
70 changes: 70 additions & 0 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
project:
type: website
output-dir: _site

website:
title: "PyMAIDR"

site-url: https://xability.github.io/maidr/
repo-url: https://github.com/xability/py_maidr
issue-url: https://github.com/xability/py_maidr/issues/new/choose
repo-actions: [issue]

page-navigation: true
bread-crumbs: true

navbar:
background: light
# logo: quarto.png
logo-alt: "Maidr logo."
logo-href: https://ischool.illinois.edu/research/projects/maidr-multimodal-access-and-interactive-data-representation
title: PyMAIDR
collapse-below: lg
left:
# - text: "Overview"
# href: index.qmd
# - text: "Get Started"
# href: get-started.qmd
- text: "API Reference"
href: api/core/index.qmd
right:
- icon: github
href: https://github.com/xability/maidr
aria-label: GitHub

format:
html:
theme: cosmo
css: styles.css
toc: true

quartodoc:
package: maidr
dir: api/core
sidebar: _sidebar.yml
style: pkgdown
title: "PyMAIDR"
renderer:
style: markdown
sections:
- title: Plot API
desc: ""
contents:
- bar
- box
- count
- heat
- hist
- line
- scatter

- title: Maidr API
desc: ""
package: maidr.core
contents:
- Maidr.render
- Maidr.show
- Maidr.save_html



Empty file added docs/get-started.qmd
Empty file.
Empty file added docs/index.qmd
Empty file.
1 change: 1 addition & 0 deletions docs/styles.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/* css styles */
4 changes: 2 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f3293ba

Please sign in to comment.