File: guide.md

package info (click to toggle)
python-griffe 1.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,256 kB
  • sloc: python: 16,348; javascript: 84; makefile: 47; sh: 24
file content (23 lines) | stat: -rw-r--r-- 832 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Guide

Welcome to the Griffe guide! Here, you’ll find a series of topics on using Griffe, along with an explanation of the project’s inner workings. Although the more detailed explanations are primarily intended for contributors, users are encouraged to read them as well, since this can deepen their understanding of Griffe and help them make the most of it.

<div class="grid cards" markdown>

-   :fontawesome-solid-user:{ .lg .middle } **User guide**

    ---

    A collection of topics for Griffe users.

    [:octicons-arrow-right-24: Browse the user guide](guide/users.md)

-   :fontawesome-solid-helmet-safety:{ .lg .middle } **Contributor guide**

    ---

    Explanation of the project and more, for Griffe contributors.

    [:octicons-arrow-right-24: Browse the contributor guide](guide/contributors.md)

</div>