https://github.com/r-koubou/keyswitchmanager.docs

KeySwitchManager's document codes which powered by Sphinx.
https://github.com/r-koubou/keyswitchmanager.docs

Last synced: 6 days ago
JSON representation

KeySwitchManager's document codes which powered by Sphinx.

• Host: GitHub
• URL: https://github.com/r-koubou/keyswitchmanager.docs
• Owner: r-koubou
• Created: 2021-06-11T10:01:30.000Z (over 3 years ago)
• Default Branch: develop
• Last Pushed: 2024-11-23T06:02:12.000Z (about 1 month ago)
• Last Synced: 2024-11-23T07:17:20.755Z (about 1 month ago)
• Size: 1.83 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# KeySwitchManager.Docs

[KeySwitchManager's](https://github.com/r-koubou/KeySwitchManager) document codes which powered by Sphinx.

## Deployment

- [Japanese](https://ja-keyswitchmanager.rtfd.io/)

- [English](https://keyswitchmanager.rtfd.io/)

## Read the Docs Project site

- [Japanese](https://readthedocs.org/projects/ja-keyswitchmanager/)

- [English](https://readthedocs.org/projects/keyswitchmanager/)

----

## Requirements

- python 3.x

- pipenv

## Rebuild the environment

```bash

python -m pip install pipenv

pipenv install

```

----

## Update i18n files

Default languege is Japanese.

(see: `source/locale/`)

### English

```bash

pipenv run make gettext

pipenv run sphinx-intl update -p build/gettext -l en

```

----

## Build (En)

```bash

cd docs/

./make_locale_en.sh

```

## Build (Ja)

```bash

cd docs/

pipenv run make html

```