Skip to content

Document API docs build path #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akmhatey-ai wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document API docs build path #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,32 @@ To learn about the available drivers and APIs see the headers
[`include/libhal-picosdk`](https://github.com/libhal/libhal-picosdk/tree/main/include/libhal-picosdk)
directory.

## API Documentation

The generated API documentation is published by
[the API docs workflow](.github/workflows/api.yml) to the central libhal API
site under the `libhal-picosdk` package name:
<https://libhal.github.io/api/libhal-picosdk/main/>.

The workflow delegates to `libhal/ci` and runs the Doxygen + Sphinx build with:

```bash
conan hal docs --doc_version <version> docs
```

For a local documentation check without publishing, install Doxygen and the
Python docs requirements, then run:

```bash
cd docs
export LIBHAL_API_VERSION=local
export LIBHAL_LOCAL_BUILD=1
doxygen doxygen.conf
python -m sphinx -b html . build/html
```

The local HTML output is written to `docs/build/html/index.html`.

## 🧰 Setup

To get started with libhal, follow the
Expand Down
4 changes: 2 additions & 2 deletions docs/doxygen.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Adapted from https://github.com/xtensor-stack/xtensor/blob/master/docs/Doxyfile
PROJECT_NAME = "libhal-arm-mcu"
PROJECT_NAME = "libhal-picosdk"
INPUT = ../include
FILE_PATTERNS = *.hpp
EXTRACT_STATIC = YES
Expand All @@ -19,4 +19,4 @@ PREDEFINED = IN_DOXYGEN
EXCLUDE_SYMBOLS = detail
GENERATE_TREEVIEW = YES
SOURCE_BROWSER = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_UNDOCUMENTED = YES
8 changes: 4 additions & 4 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
libhal-arm-mcu API documentation
=================================
libhal-picosdk API documentation
================================

.. image:: _static/logo.png
:width: 200
:align: center
:alt: libhal logo

**Welcome to libhal ARM MCU API documentation**
**Welcome to libhal-picosdk API documentation**

Here you will find an organized list of the peripheral drivers for MCUs with
ARM Cortex M processors embedded within them.

.. toctree::
:caption: libhal-arm-mcu Docs
:caption: libhal-picosdk Docs
:maxdepth: 5

Libhal Cortex M <cortex_m/index>
Expand Down