more info on editing arguments

pull/129/head
Dan Joseph 2021-12-28 10:31:44 -05:00
rodzic fa1e38f9cc
commit 56c76d18eb
2 zmienionych plików z 15 dodań i 0 usunięć

Wyświetl plik

@ -137,6 +137,14 @@ You will be prompted for your GitHub credentials.
Open https://github.com/OpenDroneMap/docs and you'll see a box asking you to open a pull request. Open a pull request by filling in a description of your changes and you're set! Somebody will review your changes and your contribution will be live on https://docs.opendronemap.org once approved.
# Options and Flags
Any additions or edits to the **Options and Flags** on https://docs.opendronemap.org/arguments/ need to happen to the `/source/arguments_edit/*.rst` files.
The `/source/arguments.rst` file is a list of all options and flags currently available in the ODM code. It is automatically created by running `scripts/extract_odm_strings.py` (you can use `make autogenerate` to run the script) and should not be manually edited. To change the descriptions within the list, the ODM code must be modified. Any manual changes to this file will be overwritten when it is next autogenerated. The script also autogenerates a file for each argument with any information available in the ODM code. These `*.rst` files are in `/source/arguments/` and should not be manually edited.
The script creates a blank `*.rst` file for each argument in `/source/arguments_edit/`. Additional details may be added to these file and will be merged with the information available in the ODM code when the documentation site is published.
# Translations
## Contributing translations

Wyświetl plik

@ -1,3 +1,10 @@
..
AUTO-GENERATED by extract_odm_strings.py! DO NOT EDIT!
This file is automatically matched to the arguments in the ODM code.
If you want to add more details to a command, edit a
.rst file in arguments_edit/<argument>.rst
Options and Flags
-----------------