From: Roland Hieber <rhi@pengutronix.de>
To: ptxdist@pengutronix.de
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: [ptxdist] [PATCH 2/2] README: mention raw documentation and how to build it
Date: Sun, 6 Jun 2021 16:51:01 +0200 [thread overview]
Message-ID: <20210606145101.21027-2-rhi@pengutronix.de> (raw)
In-Reply-To: <20210606145101.21027-1-rhi@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
README | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/README b/README
index 60ac8b152b8b..1bf3348f81ca 100644
--- a/README
+++ b/README
@@ -48,6 +48,12 @@ Documentation
See <https://www.ptxdist.org/doc/> for the full documentation, which
includes a quickstart guide as well as a reference for users and
developers.
+You can also find the documentation in reStructuredText form in the doc/
+directory inside this PTXdist tree, which you can build into HTML with
+
+ ./bin/ptxdist docs-html
+
+The generated HTML documents will be created in Documentation/html/.
Bugs
----
--
2.29.2
_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de
next prev parent reply other threads:[~2021-06-06 14:51 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-06 14:51 [ptxdist] [PATCH 1/2] doc/contributing: absorb (and slightly update) README.devel Roland Hieber
2021-06-06 14:51 ` Roland Hieber [this message]
2021-06-16 10:35 ` [ptxdist] [APPLIED] README: mention raw documentation and how to build it Michael Olbrich
2021-06-16 10:35 ` [ptxdist] [APPLIED] doc/contributing: absorb (and slightly update) README.devel Michael Olbrich
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210606145101.21027-2-rhi@pengutronix.de \
--to=rhi@pengutronix.de \
--cc=ptxdist@pengutronix.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox