Giters

tudat-team / tudat-multidoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Implement `conda` package of `multidoc` into workflow

geoffreygarrett opened this issue · comments

commented

Copy pasted from slack:

Also @Dominic Dirkx, @Filippo @Jonas Hener @Jeremie G, whoever is building documentation, would anyone have a moment during a docs build to use (and verify) this conda package for multidoc in place of our copy pasted source code for multidoc (for the tudatpy docs) I managed to publish the package yesterday and setup the pipeline, which will make any modifications to multidoc a lot easier to integrate now. If no one is sure what I'm referring to, then perhaps my questionable janky solution for tudatpy docs has gone under the radar luckily

commented

Since I'm currently working on the documentation, I tried using this multidoc conda package. (I simply renamed the current tudat-multidoc/multidoc folder so this one is not used.)
However, I get the following error:

  File "/home/jerem/miniconda3/envs/tudat-multidoc/lib/python3.8/site-packages/multidoc/template.py", line 4, in <module>
    from multidoc.utils import indent_line
ModuleNotFoundError: No module named 'multidoc.utils'

It looks to me like the multidoc conda package is missing at least the utils and the parsing modules.
This is what was installed on my machine in the multidoc conda package folder:
image

commented

Hi @gaffarelj, there should be new conda package with a build number of 1 which solves this. Let me know if any further issues are encountered.

commented

Perfect, I will test this new package.

If you have time, could you take a look and implement the latest comment I just made about the constant parser (here)? I think that changing the two lines I linked should fix the issues I have with the constant docs item.

commented

The new package is missing the numpydoc.jina2 package. I get:

FileNotFoundError: [Errno 2] No such file or directory: '/home/jerem/miniconda3/envs/tudat-multidoc/lib/python3.8/site-packages/multidoc/templates/numpydoc.jinja2'

Edit: actually, the entire multidoc/templates folder is missing.

commented

If I manually add the multidoc/templates folder (taking the one from the multidoc repo), running python cli d -p tudatpy from the tudat-bundle folder works as expected 🙂

commented

Thanks! This is my mistake. I forgot to add the templates as data_files to the setup.py which defines the pip installation. I'm going to try resolve it now.

commented

https://dev.azure.com/geoffreygarrett/feedstock-builds/_build/results?buildId=5&view=results

That is the updated build number 3.

Let me know if there's any issues. Now that the pipeline is setup, I can make the enhancements. I'll also add you as a contributor, si tu veux.

commented

That is the updated build number 3.

I don't see this build number 3 in the anaconda multidoc files. But it looks like the build was still successful...

Now that the pipeline is setup, I can make the enhancements. I'll also add you as a contributor, si tu veux.

That sounds nice. Like this I can make my changes directly without having to ask for your help every time. Merci 🙂