Skip to content

Commit 3ed31eb

Browse files
committed
Updates README.
1 parent b89ba10 commit 3ed31eb

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,15 @@ Once built HTML docs HTML pages are in `_build/html/ko`.
7979
Note: subsequent runs can omit the `-a` parameter to speed up builds (it will just build what has changed).
8080

8181

82+
Note: When build the corresponding `.mo` binary files will also be generated - these updated binaries should also be committed to Git.
83+
84+
### Depoloying
85+
86+
Docs will be automatically deployed to RTD once pushes are made to relevant branches.
87+
88+
89+
### Updating
90+
8291
- Updating, after changes on the `main` branch and a sync with the main `en` .rst files, from the "docs" location, do:
8392

8493
`sphinx-build -b gettext . _build/gettext`
@@ -91,6 +100,11 @@ then:
91100
This will update the corresponding `po` files for further edits. Then check these files for "#, fuzzy" entries as the new stuff might exist there and requires editing.
92101

93102

103+
104+
105+
106+
107+
94108
## Building PDF documentation
95109

96110
- First ensure you have [rst2pdf](https://pypi.org/project/rst2pdf/) installed:

0 commit comments

Comments
 (0)