Merge pull request #42 from neelsmith/dev

Break out functions of GreekOrthography interface
neelsmith · Apr 2, 2021 · cb4d7dc · cb4d7dc
2 parents a87d9e3 + b2cfc28
commit cb4d7dc
Show file tree

Hide file tree

Showing 32 changed files with 632 additions and 392 deletions.
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
@@ -3,7 +3,7 @@ name: Documentation
 on:
   push:
     branches:
-      - master
+      - main
     tags: '*'
   pull_request:
 

diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "PolytonicGreek"
 uuid = "72b824a7-2b4a-40fa-944c-ac4f345dc63a"
 authors = ["Neel Smith <dnsmith.neel@gmail.com>"]
-version = "0.6.3"
+version = "0.7.0"
 
 [deps]
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
@@ -13,5 +13,5 @@ Unicode = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
 [compat]
 DocStringExtensions = "0.8"
 Documenter = "0.26"
-Orthography = "0.6"
+Orthography = "0.7"
 julia = "1.5"
diff --git a/README.md b/README.md
@@ -4,10 +4,8 @@ A Julia module for working with polytonic ancient Greek.
 
 See documentation [here](https://neelsmith.github.io/PolytonicGreek.jl/stable/).
 
-## Pluto notebooks
-
-The `pluto` directory has notebooks demonstrating usage of the package that you'll be able to run once the package is available from the Julia Registry.  It's currently out of date, and needs to be updated.  
 
+The `pluto` directory has notebooks demonstrating usage of some older versions of the package.
 
 You can also run them on binder using these links:
 

diff --git a/docs/make.jl b/docs/make.jl
@@ -15,19 +15,13 @@ makedocs(
         "Home" => "index.md",
         "Manual" => Any[
             "guide/orthography.md",
+            "guide/orthography-details.md",
             "guide/sorting.md",
             "guide/accents.md",
             "guide/syllabification.md",
             "utilities.md"
         ],
-        "API documentation" => Any[
-            "api/apis_ortho.md",
-            "api/apis_sorting.md",
-            "api/apis_accents.md",
-            "api/apis_syllables.md",
-            "api/apis_other.md",
-
-        ]
+        "API documentation" => "api/index.md"
     ]
 )
 

diff --git a/docs/src/api/apis_accents.md b/docs/src/api/apis_accents.md
diff --git a/docs/src/api/apis_ortho.md b/docs/src/api/apis_ortho.md
diff --git a/docs/src/api/apis_other.md b/docs/src/api/apis_other.md
diff --git a/docs/src/api/apis_sorting.md b/docs/src/api/apis_sorting.md
diff --git a/docs/src/api/apis_syllables.md b/docs/src/api/apis_syllables.md
diff --git a/docs/src/api/index.md b/docs/src/api/index.md
@@ -0,0 +1,89 @@
+# API documentation
+
+
+```@contents
+Pages = ["index.md"]
+Depth = 3
+```
+
+## Accentuation
+
+### Exported functions
+
+```@docs
+rmaccents
+accentword
+```
+
+
+### Internals
+
+```@docs
+PolytonicGreek.allaccents
+PolytonicGreek.accentstripdict
+PolytonicGreek.flipdict
+PolytonicGreek.acutedict
+PolytonicGreek.circumflexdict
+PolytonicGreek.addacute
+PolytonicGreek.addcircumflex
+PolytonicGreek.accentsyllable
+PolytonicGreek.accentultima
+PolytonicGreek.accentpenult
+PolytonicGreek.accentantepenult
+PolytonicGreek.ultima
+PolytonicGreek.penult
+PolytonicGreek.longsyllable
+PolytonicGreek.shortsyllable
+PolytonicGreek.includesdiphthong
+PolytonicGreek.flipaccent
+PolytonicGreek.vowelsonly
+PolytonicGreek.tokenform
+PolytonicGreek.countaccents
+PolytonicGreek.stripenclitic
+PolytonicGreek.normalizediaresis
+PolytonicGreek.normalizeaccentcombos
+```
+
+##  Orthography
+
+
+### Exported functions and structure
+
+```@docs
+LiteraryGreekOrthography
+literaryGreek
+tokenizeLiteraryGreek
+```
+
+### Internals
+
+```@docs
+PolytonicGreek.alphabetic
+PolytonicGreek.punctuation
+PolytonicGreek.isAlphabetic
+PolytonicGreek.isPunctuation
+PolytonicGreek.sortWords
+PolytonicGreek.tokenforstring
+PolytonicGreek.splitPunctuation
+```
+
+## Syllabification
+
+### Exported function
+
+```@docs
+syllabify
+```
+
+
+### Internals
+
+Syllabification is implemented with a chain of functions applying regular expressions to an input string.  These internal functions would not normally be of any use or interest to anyone who simply wants to break a string in polytonic Greek into syllables.
+
+```@docs
+PolytonicGreek.splitmorphemeboundary
+PolytonicGreek.splitmunu
+PolytonicGreek.splitliqcons
+PolytonicGreek.splitdiphthongvowel
+PolytonicGreek.splitvoweldiphthong
+```
diff --git a/docs/src/guide/orthography-details.md b/docs/src/guide/orthography-details.md
@@ -0,0 +1 @@
+# Orthography: gorey details
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,7 @@ name: Documentation @@
     on:
       push:
         branches:
-          - master
+          - main
         tags: '*'
       pull_request:
@@ Expand Down @@