mirror of
https://gitlab.cern.ch/wotsubo/PSBoardDataBase.git
synced 2025-06-12 15:59:22 +09:00
update: docs(main description)
This commit is contained in:
parent
98d246a054
commit
48e83bfe18
6 changed files with 468 additions and 19 deletions
29
docs/src/about_software.md
Normal file
29
docs/src/about_software.md
Normal file
|
@ -0,0 +1,29 @@
|
|||
```@meta
|
||||
CurrentModule = PSBoardDataBase
|
||||
```
|
||||
# このリポジトリのソフトウェアについての説明
|
||||
|
||||
このリポジトリにあるのは、JATHub masterのログファイル、及びGoogle SheetsからエクスポートしたCSVファイルからデータベースを作成するためのコードである。
|
||||
メインの関数は[`create_database_from_exported_csvs`](@ref)である。
|
||||
|
||||
## テストについて
|
||||
|
||||
テストでは実際にデータベースを作成している。
|
||||
デフォルトでは全部は実行しないが、master log fileをおき、かつ環境変数`LOCAL_TEST`を設定することで、master log fileが必要な工程まで含めて実行できる。[^1]
|
||||
|
||||
[^1]: master log fileはgitには入れたくないので、このような形態をとっている。
|
||||
|
||||
## API
|
||||
|
||||
```@index
|
||||
```
|
||||
|
||||
```@autodocs
|
||||
Modules = [PSBoardDataBase]
|
||||
```
|
||||
|
||||
### `QaqcMasterLog`
|
||||
|
||||
```@autodocs
|
||||
Modules = [QaqcMasterLog]
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue