Skip to content

Commit

Permalink
[fix] For _devbuild/gen/help_.py
Browse files Browse the repository at this point in the history
spec/builtin-completion requires 'false' in the help topics

doc/ref: Add help terminology
  • Loading branch information
Andy C committed Aug 5, 2023
1 parent 5fbb244 commit 95cbd7a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
8 changes: 3 additions & 5 deletions build/doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -373,15 +373,13 @@ cards-from-indices() {
cards-from-chapters() {
### Do all cards at once

# TODO: We need to re-indent <code> blocks here, etc.

local py_out=$CODE_DIR/help_.py
# TODO: unify the list of help topics
local py_out=$CODE_DIR/ignored.py
# h4 tag for these
_make-help cards-from-chapter $TEXT_DIR $py_out h4 \
$HTML_DIR/doc/osh-help.html $HTML_DIR/doc/ysh-help.html

# TODO: unify the list of help topics
local py_out=$CODE_DIR/fixme.py
local py_out=$CODE_DIR/help_.py
# h3
_make-help cards-from-chapter $TEXT_DIR $py_out h3 \
$HTML_DIR/doc/ref/chap-*.html
Expand Down
10 changes: 10 additions & 0 deletions doc/osh-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -729,6 +729,16 @@ Examples:
help osh-usage # identical to osh --help
help ysh-usage # ditto
Help terminology:
Oils Reference: underlies 'help' builtin, and published as HTML
Chapter: An HTML doc that's part of the reference
May apply to OSH, YSH or both
Section: <h2> in a chapter
Topic: <h3> in a chapter, with name like 'doc-comment'
May apply to OSH, YSH or both
Card: Each topic is exported as a "card"
All docs, including this reference:
https://www.oilshell.org/release/$VERSION/doc/
Expand Down

0 comments on commit 95cbd7a

Please sign in to comment.