executablebooks / rst-to-myst

Convert ReStructuredText to MyST Markdown
https://rst-to-myst.readthedocs.io
MIT License
64 stars 11 forks source link

Designate output directory #26

Open stevepiercy opened 3 years ago

stevepiercy commented 3 years ago

Is your feature request related to a problem? Please describe.

When converting all files, a new file is created as a sibling to the original. I must copy all these files to separate directory to build the converted files and compare to the original.

Describe the solution you'd like

It would be nice to be able to designate an output directory separate from the source directory. This would make it easier to build the converted files.

Describe alternatives you've considered

There might be an existing option to redirect output of which I am not aware, whether that is with this app or a shell command. I might create a shell script that uses rsync to move files into a separate directory to build the converted docs.

welcome[bot] commented 3 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

chrisjsewell commented 3 years ago

thanks, yeh this shouldn't be too difficult, although I haven't got much time to do it right now 😬

The way I have set it up to run now is best used with a git version controlled repo. Then you can run and compare the changes with a git related tool

If you want to try making a PR, the code to change would be here: https://github.com/executablebooks/rst-to-myst/blob/2af0b738e2c46a33c5a0937b410c12a679a217c8/rst_to_myst/cli.py#L329

stevepiercy commented 3 years ago

Thanks for the pointer to the code. I wrote a shell script that I think I can adapt for this purpose. It's also on my "things to do for open source list". 😜

chrisjsewell commented 3 years ago

Haha yeh my TODO list always seems to get longer

stevepiercy commented 3 years ago

Our motto in the Pylons Project: "Operating at the speed of open source."