Skip to content

Commit e5f1fa2

Browse files
committedJan 25, 2025·
Added howto for quartodoc
1 parent 4ebb49b commit e5f1fa2

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed
 

‎CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ We appreciate your contributions and look forward to reviewing your pull request
7272

7373
* Follow the Numpydoc docstring style for the documentation, see [link](https://numpydoc.readthedocs.io/en/latest/format.html)
7474

75+
* To generate .qmd files for package documentation, see tutorial in [_quarto.yml](_quarto.yml)
76+
7577
## Makefile
7678

7779
The `marginaleffects` repository includes a `Makefile` to facilitate some common tasks.

‎_quarto.yml

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
####### README #######
2-
# This is the config file to build .qmd files
3-
#
4-
# This references the marginaleffects in .venv first, to reference the local marginaleffects, delete or rename the folder marginaleffects in .venv/lib/
2+
# This is the HOWTO and the config file to build .qmd files
3+
#
4+
# First install quartodoc with `uv pip install quartodoc`
55
#
66
# To create the qmd files, run the following command in the terminal:
77
# > quartodoc build
8-
# the result will be in ./qmd_files or else specified in the dir field
8+
# the result will be in ./qmd_files or (else specified in the dir field)
99
# modify the current file to change the included functions and the layout
1010
# finally, run the following command to preview the website if wanted:
1111
# > quarto preview
12+
#
13+
# NOTE: This references the marginaleffects in .venv first, to reference the local marginaleffects, delete or rename the folder marginaleffects in .venv/lib/
1214

1315

1416
project:

0 commit comments

Comments
 (0)
Please sign in to comment.