Skip to content
This repository has been archived by the owner on Apr 16, 2024. It is now read-only.

"paper.md" found twice, even though there is only one #80

Open
PABourdin opened this issue Aug 12, 2020 · 7 comments
Open

"paper.md" found twice, even though there is only one #80

PABourdin opened this issue Aug 12, 2020 · 7 comments

Comments

@PABourdin
Copy link

Using the webpage for looking at a paper preview:
https://whedon.theoj.org/
I can give the correct URL to our repository that contains exactly one "paper.md":
https://github.com/pencil-code/pencil-code
But the compilation aborts after some time with a wrong error message that there would be multiple "paper.md" files.

Just we have our "paper" directory as a subdirectory of "doc", which we require to have there because of our code structure:
pencil-code/doc/paper/paper.md

If I give instead this URL to the preview tool:
https://github.com/pencil-code/pencil-code/doc
I have the same result as if I would give a non-existent URL, see issue #79

@arfon
Copy link
Member

arfon commented Aug 12, 2020

This is failing because Whedon looks for files named paper.md and paper.tex and you have one of each (https://github.com/pencil-code/pencil-code/blob/master/misc/f90-timings/doc/paper.tex, https://github.com/pencil-code/pencil-code/blob/master/doc/paper/paper.md).

Ultimately we will need to find a way to allow people to specify which paper they want to compile. For now though this isn't possible sorry.

One potential short term fix is for you to rename https://github.com/pencil-code/pencil-code/blob/master/misc/f90-timings/doc/paper.tex to something other than paper.tex

@PABourdin
Copy link
Author

@arfon
Yes, being able to choose the file name, or better the full path to the *.md file, is a "must have" if you want your application to be usable for established software project that will probably already have several "paper.tex" or "paper.md" in place, somewhere.

So yes, please consider this as a strong support to your comment.

@arfon
Copy link
Member

arfon commented Aug 15, 2020

We also support alternative branches so you can always create a joss-paper branch for your project and have the JOSS paper be the only paper.md in the source code on that branch.

@PABourdin
Copy link
Author

@arfon
Thanks for the hint, but we do not use branches that would become "stale" in our case very quickly...

@arfon
Copy link
Member

arfon commented Aug 16, 2020

Thanks for the hint, but we do not use branches that would become "stale" in our case very quickly...

OK, well I've given you a few suggested solutions here. We don't have a lot of capacity to work on improving the preview service right now sorry so if this is a blocker for you to submit, you'll need to use one one of the suggestions I've offered here.

@arfon
Copy link
Member

arfon commented Aug 16, 2020

/ cc @tarleb - this is an example of where the Docker-powered author preview tool could help :-)

@PABourdin
Copy link
Author

@arfon
Sorry, please do not get me wrong, here. I have already fixed the issue on our side as you suggested. I'm just telling that having a proper way to define the filename, or alternatively the subdirectory to search for "paper.md", as you suggested, is what I would also strongly recommend to do. - From the perspective of the owners of large scientific codes with history.

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

No branches or pull requests

2 participants