Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build cli tool #5

Open
charlesreid1 opened this issue May 15, 2018 · 5 comments
Open

build cli tool #5

charlesreid1 opened this issue May 15, 2018 · 5 comments

Comments

@charlesreid1
Copy link
Owner

see how this repo is organized page for prototype

@charlesreid1
Copy link
Owner Author

charlesreid1 commented May 15, 2018

what information is needed

  • source docs directory
  • target docs directory
  • target translation language

what information is optional

  • are you running with mkdocs

@charlesreid1
Copy link
Owner Author

no command line options

if the cli tool is run with no command line options, run through an interactive set of steps to ask the user for the information the program needs. Provide some sensible defaults.

@charlesreid1
Copy link
Owner Author

source and target options

should be able to specify source and target directory on command line with --source and --target:

$ translate_the_docs --source=doc/ --target=ru_docs

@charlesreid1
Copy link
Owner Author

language options

should be able to specify target language with --language:

$ translate_the_docs --source=doc/ --target=ru_docs --language=ru

@charlesreid1
Copy link
Owner Author

mkdocs options

Should be able to specify that we are using mkdocs and we want to translate the page titles in mkdocs.yml:

$ translate_the_docs --source=doc/ --target=ru_docs --language=ru --mkdocs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant