https://hellosystem.github.io/docs/

This repository builds the documentation for hello
https://hellosystem.github.io/docs/

hellosystem

Last synced: 3 months ago
JSON representation

This repository builds the documentation for hello

• Host: GitHub
• URL: https://hellosystem.github.io/docs/
• Owner: helloSystem
• License: bsd-2-clause
• Created: 2020-11-25T17:31:12.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-14T14:46:31.000Z (7 months ago)
• Last Synced: 2024-04-15T14:36:41.982Z (7 months ago)
• Topics: hellosystem
• Language: Shell
• Homepage: https://hellosystem.github.io/docs/
• Size: 3.59 MB
• Stars: 20
• Watchers: 5
• Forks: 23
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-bsd - handbook

README

        
# hello Documentation

This repository builds the [documentation](https://hellosystem.github.io/docs/) for hello.

It uses Sphinx, recommonmark, and GitHub Actions to produce documentation from the Markdown source files in this repository.

* https://stackoverflow.com/a/62967771

* https://recommonmark.readthedocs.io/en/latest/

## Local development server

Use a local development server that regenerates the output whenever the input changes:

```sh

sudo pkg install -y py37-pip gmake # on FreeBSD, e.g., on helloSystem

pip-3.7 install -r requirements.txt

export GITHUB_REPOSITORY="helloSystem/docs"

export PATH=~/.local/bin/:$PATH

gmake watch

```

Now open http://127.0.0.1:8000 in a web browser. It will be regenerated and refreshed whenever one of the input files changes.

## Local output generation

One can also generate documentation in various output formats locally:

```sh

sudo pkg install -y py37-pip gmake # on FreeBSD, e.g., on helloSystem

pip-3.7 install -r requirements.txt

export GITHUB_REPOSITORY="helloSystem/docs"

export PATH=~/.local/bin/:$PATH

gmake html

gmake epub

gmake html

gmake qthelp

qmake # list more output formats

```