Skip to content

Commit

Permalink
[docs] fix API sig; add badge; fix dup heading
Browse files Browse the repository at this point in the history
  • Loading branch information
2bndy5 committed Nov 3, 2021
1 parent 496f5da commit 3befead
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![Linux build](https://github.com/nRF24/RF24/workflows/Linux%20build/badge.svg)](https://github.com/nRF24/RF24/actions?query=workflow%3A%22Linux+build%22)
[![PlatformIO build](https://github.com/nRF24/RF24/actions/workflows/build_platformIO.yml/badge.svg)](https://github.com/nRF24/RF24/actions/workflows/build_platformIO.yml)
[![RP2xxx build](https://github.com/nRF24/RF24/actions/workflows/build_rp2xxx.yml/badge.svg)](https://github.com/nRF24/RF24/actions/workflows/build_rp2xxx.yml)
[![Documentation Status](https://readthedocs.org/projects/rf24/badge/?version=latest)](https://rf24.readthedocs.io/en/latest/?badge=latest)

# See http://nRF24.github.io/RF24 for all documentation

Expand Down
2 changes: 1 addition & 1 deletion docs/python_wrapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- markdownlint-disable MD031 -->
By [mz-fuzzy](https://github.com/mz-fuzzy)

## Prerequisites
## Python Wrapper Prerequisites

### RF24

Expand Down
26 changes: 26 additions & 0 deletions docs/sphinx/_static/custom_material.css
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,29 @@ html .md-nav--primary .md-nav__title--site .md-nav__button {
background-color: var(--md-default-bg-color--light);
margin-right: 0.5rem;
}

/* ************* temp workaround styling multi-line API signatures ******************* */
/* In the future, we plan to do this without CSS in a more programatic way, but for now... */

.md-typeset dl.objdesc>dt.sig-wrap .n + .sig-paren::before,
.md-typeset dl.api-field>dt.sig-wrap .n + .sig-paren::before {
content: "\a ";
white-space: pre;
}

.md-typeset dl.objdesc>dt.sig-wrap .sig-paren + .n:not(.sig-param)::before,
.md-typeset dl.api-field>dt.sig-wrap .sig-paren + .n:not(.sig-param)::before,
.md-typeset dl.objdesc>dt.sig-wrap .sig-param + .sig-param::before,
.md-typeset dl.api-field>dt.sig-wrap .n.sig-param + .kt::before,
.md-typeset dl.objdesc>dt.sig-wrap .n.sig-param + .kt::before,
.md-typeset dl.api-field>dt.sig-wrap .n.sig-param + .n:not(.sig-param)::before,
.md-typeset dl.objdesc>dt.sig-wrap .n.sig-param + .n:not(.sig-param)::before {
content: "\a ";
white-space: break-spaces;
}

.md-typeset dl.api-field>dt.sig-wrap .sig-param:before,
.md-typeset dl.objdesc>dt.sig-wrap .sig-param:before {
content: unset;
white-space: pre;
}

0 comments on commit 3befead

Please sign in to comment.