[WIP] A proper sphinx documentation

[hadware]

Should contain;

• [ ] everything that is already in the readme
• [ ] maybe more code samples
• [ ] API reference with autodoc

@mmmaat if you have any other suggestions

[codecov[bot]]

Codecov Report

Merging #115 (eba83f0) into master (6072727) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #115   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           23        23           
  Lines         1184      1184           
=========================================
  Hits          1184      1184           

Impacted Files	Coverage Δ
phonemizer/backend/base.py	100.00% <ø> (ø)
phonemizer/backend/festival/festival.py	100.00% <ø> (ø)
phonemizer/phonemize.py	100.00% <ø> (ø)
phonemizer/separator.py	100.00% <ø> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 6072727...eba83f0. Read the comment docs.

[mmmaat]

Well, good idea, the README is too big to be comfortable...

• [ ] deploy the doc website with a github action on a new release
• [ ] From #113 it must be clearer how to efficiently use the EspeakBackend

No other ideas for now :)

[hadware]

@mmmaat could you look into the current sphinx doc and tell me what you think?

i'll take care of fixing the github action after merging this :)

[mmmaat]

Hi @hadware! Sure you can merge!! I guess you'll add the link to doc on the README after that. Cheers!