Documentation clean up

Author: albbas

docs/docs/index.md

@@ -6,11 +6,15 @@ _CorpusTools_ is a set of tools to administrate Giellatekno's corpora.
 
 A few examples:
 
-- [add_files_to_corpus](scripts/add_files_to_corpus) - Add raw source material files to a corpus
-- [convert2xml](scripts/convert2xml) - Converts original files to the Giellatekno-internal xml format.
-- [analyse_corpus](scripts/analyse_corpus) - Orchistrates the _hfst_ (etc) tools to run analysis on a corpus.
-- [ccat](scripts/ccat) - Output text sections from an analysed or non-analysed corpus.
-- [korp_mono](scripts/korp_mono) - Convert analysed files to korp-input
+- [add_files_to_corpus](scripts/add_files_to_corpus.md) - Add raw source
+  material files to a corpus
+- [convert2xml](scripts/convert2xml.md) - Converts original files to the
+  Giellatekno-internal xml format.
+- [analyse_corpus](scripts/analyse_corpus.md) - Orchistrates the _hfst_ (etc)
+  tools to run analysis on a corpus.
+- [ccat](scripts/ccat.md) - Output text sections from an analysed or
+  non-analysed corpus.
+- [korp_mono](scripts/korp_mono.md) - Convert analysed files to korp-input
 
 ## Installation from apertium nightly
 
@@ -21,20 +25,22 @@ will find it.
 
 ## Installation using pipx
 
-> pipx lets you install python packages that has runnable scripts easily,
-> onto your system.
+> pipx lets you install python packages that has runnable scripts easily, onto
+> your system.
 
 1. Install [pipx](https://pypa.github.io/pipx/installation/)
 1. Run `pipx install --force git+https://github.com/divvun/CorpusTools.git`
 
 ### Editable install (alternate pipx installation method)
 
 An _editable_ install lets you make changes in the source script files, and
-still use the same global command on the command line to run the (modified) scripts.
-Recommended if you intend to do development on the scripts.
+still use the same global command on the command line to run the (modified)
+scripts. Recommended if you intend to do development on the scripts.
 
-1. Clone the CorpusTools repository: (`git clone https://github.com/divvun/CorpusTools.git CorpusTools`)
-1. Install with the editable flag (`-e`): `pipx install -e --force /path/to/CorpusTools`
+1. Clone the CorpusTools repository:
+   (`git clone https://github.com/divvun/CorpusTools.git CorpusTools`)
+1. Install with the editable flag (`-e`):
+   `pipx install -e --force /path/to/CorpusTools`
 
 ### Requirements
 
@@ -43,14 +49,12 @@ Recommended if you intend to do development on the scripts.
 - pandoc (only needed for convert2xml?)
 
 Installation commands
-=== "Mac"
+===================== "Mac"
 
-    ```
-    sudo port install latex2html poppler pandoc
-    ```
+    ``` sudo port install latex2html poppler pandoc ```
 
-=== "Debian/Ubuntu"
+"Debian/Ubuntu"
 `sudo apt-get install poppler-utils pandoc`
 
-=== "Arch Linux"
+"Arch Linux"
 `sudo pacman -S pandoc`

docs/docs/scripts/index.md

@@ -1,16 +1,14 @@
 # Overview
 
-CorpusTools is a collection of scripts, each doing one specialized task.
-When the CorpusTools are installed, these can be run directly from the
-command-line.
+CorpusTools is a collection of scripts, each doing one specialized task. When
+the CorpusTools are installed, these can be run directly from the command-line.
 
 terminology:
-     - "module" - the folder in the root folder, e.g.
-         "converted", "korp", "analysed", "tmx",
-         and also directories that are part of different "areas" (??), like:
-         "goldstandard/converted", "correct-no-gs/converted"
+     - "module" - the folder in the root folder, e.g. "converted", "korp",
+       "analysed", "tmx", and also directories that are part of different
+       "areas" (??), like: "goldstandard/converted", "correct-no-gs/converted"
 
 
-- [add\_files\_to\_corpus](add_files_to_corpus)
-- [convert2xml](convert2xml)
-- [analyse\_corpus](analyse_corpus)
+- [add\_files\_to\_corpus](add_files_to_corpus.md)
+- [convert2xml](convert2xml.md)
+- [analyse\_corpus](analyse_corpus.md)

docs/gen_ref_pages.py

@@ -14,7 +14,7 @@
 
 for path in sorted(Path("..", "corpustools").rglob("*.py")):
     module_path = path.relative_to("..").with_suffix("")
-    doc_path = path.relative_to("..", "corpustools").with_suffix(".md")
+    doc_path = path.relative_to(Path("..") / "corpustools").with_suffix(".md")
     full_doc_path = Path("reference", doc_path)
 
     parts = tuple(module_path.parts)

docs/mkdocs.yml

@@ -39,7 +39,6 @@ nav:
           - normalise_corpus_names: scripts/normalise_corpus_names.md
           - paracheck: scripts/paracheck.md
           - parallelize: scripts/parallelize.md
-          - pick_parallel_docs: scripts/pick_parallel_docs.md
           - remove_corpus_file: scripts/remove_corpus_file.md
           - reparallelize: scripts/reparallelize.md
           - saami_crawler: scripts/saami_crawler.md