googleapis / sphinx-docfx-yaml

Forked sphinx-docfx-yaml repository for creating DocFX YAML for Python Client Libraries
Apache License 2.0
5 stars 7 forks source link

refactor: move markdown into its own file & testing #259

Closed dandhlee closed 2 years ago

dandhlee commented 2 years ago

Taking Markdown functionality out of the extension file. The file is way too big and should be refactored further.

Updated docstring for all of the Markdown methods as well.

Moved the testing into its own file, however I've temporarily included unit tests for private methods as well, as we don't have goldens testing yet at the moment. Goldens testing will follow next, before more refactoring can be done to ensure the refactoring doesn't actually change the output format.

Updates #115. Towards #44.

dandhlee commented 2 years ago

Thank you! Please take a look again.