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

Improve automatic manual conversion #4830

Merged
merged 10 commits into from May 25, 2022
Merged

Conversation

gassmoeller
Copy link
Member

These are some improvements to the automatically converted manual that we should have done at the start of the hack. I added the script commands I used to improve the conversion into the detailed description of the git commits. There is still some manual fix-up to do for all remaining cookbooks and benchmarks, but this should make the remaining proof-reading simpler.

@cmills1095: We talked about regular expressions at the hack, this might be interesting for you.

Running perl -pi -e 's/\[(.*?\.prm)\]\[\]/\[$1\]\(https\:\/\/www\.github\.com\/geodynamics\/aspect\/blob\/main\/$1\)/gm;' `find -L user -name '*.md'`
perl -pi -e 's/\[(.*?\.cc)\]\[\]/\[$1\]\(https\:\/\/www\.github\.com\/geodynamics\/aspect\/blob\/main\/$1\)/gm;' `find -L user -name '*.md'`
perl -pi -e 's/\[\\\[(parameters:.*)\\\]\]\[[0-9]*\]/{ref}\`$1\`/gm;' `find -L user -name '*.md'`
perl -pi -e 's/\[\\\[(sec:.*)\\\]\]\[[0-9]*\]/{ref}\`$1\`/gm;' `find -L user -name '*.md'`
perl -pi -e 's/\#\#\#\#\#/\#\#/gm;' `find -L . -name '*.md'`
perl -pi -e 's/\#\#\#\#/\#/gm;' `find -L  -name '*.md'`
perl -pi -e 's/\&ldquo\;\`(.*?)\`\&rdquo\;/\`$1\`/gm;' `find -L  -name '*.md'`
perl -pi -e "s/ \&rsquo\;s/ ASPECT\'s/gm;" `find -L  -name '*.md'`
@gassmoeller
Copy link
Member Author

I will merge this with #4831 to a single script. That way we avoid conflicts and have it in a single place in case we need it again.

@bangerth
Copy link
Contributor

OK to merge. Why don't you want to merge this by itself?

@gassmoeller
Copy link
Member Author

I thought I add the commands to the script I am writing for #4831. But of course we can merge this anyway and still add the commands to the script for future reference.

@gassmoeller gassmoeller merged commit 5eb26fd into geodynamics:main May 25, 2022
@gassmoeller gassmoeller deleted the doc branch May 25, 2022 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants