Issue #135: Update docs with file types and directory indicators

scribe-org · Aug 19, 2024 · e57bf16 · e57bf16
1 parent a82b9f1
commit e57bf16
Show file tree

Hide file tree

Showing 24 changed files with 48 additions and 48 deletions.
diff --git a/docs/source/scribe_data/cli.rst b/docs/source/scribe_data/cli.rst
@@ -1,5 +1,5 @@
-cli
-===
+cli/
+====
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/cli>`_
 

diff --git a/docs/source/scribe_data/language_data_extraction/index.rst b/docs/source/scribe_data/language_data_extraction/index.rst
@@ -1,5 +1,5 @@
-language_data_extraction
-========================
+language_data_extraction/
+=========================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/language_data_extraction>`_
 

diff --git a/docs/source/scribe_data/load/data_to_sqlite.rst b/docs/source/scribe_data/load/data_to_sqlite.rst
@@ -1,5 +1,5 @@
-data_to_sqlite
-==============
+data_to_sqlite.py
+=================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/load/data_to_sqlite.py>`_
 

diff --git a/docs/source/scribe_data/load/send_dbs_to_scribe.rst b/docs/source/scribe_data/load/send_dbs_to_scribe.rst
@@ -1,5 +1,5 @@
-send_dbs_to_scribe
-==================
+send_dbs_to_scribe.py
+=====================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/load/send_dbs_to_scribe.py>`_
 

diff --git a/docs/source/scribe_data/translation/index.rst b/docs/source/scribe_data/translation/index.rst
@@ -1,5 +1,5 @@
-translation
-===========
+translation/
+============
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/translation>`_
 

diff --git a/docs/source/scribe_data/translation/query_words_to_translate.rst b/docs/source/scribe_data/translation/query_words_to_translate.rst
@@ -1,5 +1,5 @@
-query_words_to_translate
-========================
+query_words_to_translate.sparql
+===============================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/translation/query_words_to_translate.sparql>`_
 

diff --git a/docs/source/scribe_data/translation/translation_utils.rst b/docs/source/scribe_data/translation/translation_utils.rst
@@ -1,5 +1,5 @@
-translation_utils
-=================
+translation_utils.py
+====================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/translation/translation_utils.py>`_
 

diff --git a/docs/source/scribe_data/translation/update_words_to_translate.rst b/docs/source/scribe_data/translation/update_words_to_translate.rst
@@ -1,5 +1,5 @@
-update_words_to_translate
-=========================
+update_words_to_translate.py
+============================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/translation/update_words_to_translate.py>`_
 

diff --git a/docs/source/scribe_data/unicode/index.rst b/docs/source/scribe_data/unicode/index.rst
@@ -1,5 +1,5 @@
-unicode
-=======
+unicode/
+========
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/unicode>`_
 

diff --git a/docs/source/scribe_data/unicode/process_unicode.rst b/docs/source/scribe_data/unicode/process_unicode.rst
@@ -1,5 +1,5 @@
-process_unicode
-===============
+process_unicode.py
+==================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/unicode/process_unicode.py>`_
 

diff --git a/docs/source/scribe_data/unicode/unicode_utils.rst b/docs/source/scribe_data/unicode/unicode_utils.rst
@@ -1,5 +1,5 @@
-unicode_utils
-=============
+unicode_utils.py
+================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/unicode/unicode_utils.py>`_
 

diff --git a/docs/source/scribe_data/unicode/update_unicode_data.rst b/docs/source/scribe_data/unicode/update_unicode_data.rst
@@ -1,5 +1,5 @@
-update_unicode_data
-===================
+update_unicode_data.py
+======================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/unicode/update_unicode_data.py>`_
 

diff --git a/docs/source/scribe_data/utils.rst b/docs/source/scribe_data/utils.rst
@@ -1,5 +1,5 @@
-utils
-=====
+utils.py
+========
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/utils.py>`_
 

diff --git a/docs/source/scribe_data/wikidata/check_query/check.rst b/docs/source/scribe_data/wikidata/check_query/check.rst
@@ -1,5 +1,5 @@
-check
-=====
+check.py
+========
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/wikidata/check_query/check.py>`_
 

diff --git a/docs/source/scribe_data/wikidata/check_query/index.rst b/docs/source/scribe_data/wikidata/check_query/index.rst
@@ -1,5 +1,5 @@
-check_query
-===========
+check_query/
+============
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/wikidata/check_query>`_
 

diff --git a/docs/source/scribe_data/wikidata/check_query/query.rst b/docs/source/scribe_data/wikidata/check_query/query.rst
@@ -1,5 +1,5 @@
-query
-=====
+query.py
+========
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/wikidata/check_query/query.py>`_
 

diff --git a/docs/source/scribe_data/wikidata/check_query/sparql.rst b/docs/source/scribe_data/wikidata/check_query/sparql.rst
@@ -1,5 +1,5 @@
-sparql
-======
+sparql.py
+=========
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/wikidata/check_query/sparql.py>`_
 

diff --git a/docs/source/scribe_data/wikidata/index.rst b/docs/source/scribe_data/wikidata/index.rst
@@ -1,5 +1,5 @@
-wikidata
-========
+wikidata/
+=========
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/wikidata>`_
 

diff --git a/docs/source/scribe_data/wikidata/query_profanity.rst b/docs/source/scribe_data/wikidata/query_profanity.rst
@@ -1,5 +1,5 @@
-query_profanity
-===============
+query_profanity.sparql
+======================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/wikidata/query_profanity.sparql>`_
 

diff --git a/docs/source/scribe_data/wikipedia/extract_wiki.rst b/docs/source/scribe_data/wikipedia/extract_wiki.rst
@@ -1,5 +1,5 @@
-extract_wiki
-============
+extract_wiki.py
+===============
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/wikipedia/extract_wiki.py>`_
 

diff --git a/docs/source/scribe_data/wikipedia/gen_autosuggestions.rst b/docs/source/scribe_data/wikipedia/gen_autosuggestions.rst
@@ -1,5 +1,5 @@
-gen_autosuggestions
-===================
+gen_autosuggestions.ipynb
+=========================
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/wikipedia/gen_autosuggestions.ipynb>`_
 

diff --git a/docs/source/scribe_data/wikipedia/index.rst b/docs/source/scribe_data/wikipedia/index.rst
@@ -1,5 +1,5 @@
-wikipedia
-=========
+wikipedia/
+==========
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/wikipedia>`_
 

diff --git a/docs/source/scribe_data/wikipedia/process_wiki.rst b/docs/source/scribe_data/wikipedia/process_wiki.rst
@@ -1,5 +1,5 @@
-process_wiki
-============
+process_wiki.py
+===============
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/wikipedia/process_wiki.py>`_
 

diff --git a/docs/source/scribe_data/wiktionary/index.rst b/docs/source/scribe_data/wiktionary/index.rst
@@ -1,5 +1,5 @@
-wiktionary
-==========
+wiktionary/
+===========
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/wiktionary>`_