Bug Report: Documentation Won't Build

[edwinlima]

I'm generating the documentation under windows 10 and anaconda environement and I'm getting the following error when running "make html":

reading sources... [ 81%] examples
Exception occurred:
File "C:\Users\Eigenaar\Anaconda3\lib\pathlib.py", line 1046, in _opener
return self._accessor.open(self, flags, mode)
FileNotFoundError: [Errno 2] No such file or directory: 'G:\GitHub\mplfinance\doc\source\..\..\examples\date_demo1.py'
The full traceback has been saved in C:\Users\Eigenaar\AppData\Local\Temp\sphinx-err-7rb4yftl.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at https://github.com/sphinx-doc/sphinx/issues. Thanks!

• OS: Windows
• Python 3.7.5/Anaconda

Any hints?

[DanielGoldfarb]

@edwinlima

Thank you very much for posting this issue.

The documentation that is generated under the doc folder is only for the old api.

The documentation for the new api consists of the basic usage outlined here and the five or so jupyter notebooks in the examples folder.

Please note that the documentation that you are trying to generate has not changed for three years (and is still posted here).

The reason for this situation as partially explained here is that the old api was unmaintained for over three years and, since taking over this package four and a half months ago, I have not made time to teach myself sphinx and how the whole process of generating and publishing the documentation (to matplotlib.org) works.

I'm sure the whole process is a relatively easy thing to learn. None-the-less, my focus has been on building out the new api to the point where it can completely replace the old api. (It is my hope to acheive that sometime in the next 4 to 8 weeks).

If you are familiar with sphinx, or willing to get involved with generating sphinx the documentation, your help and contribution would get greatly appreciated. I very much want the matplotlib.org documentation to include the new API (and, if possible, the new api tutorials in the basic usage section and in the jupyter notebooks).

If I had to guess why the documentation build is failing, I would suspect (based on the error text that you posted) the reason is that the example .py files have moved moved from the examples folder to the examples/original_flavor folder, and possibly also because the file containing the old api has been renamed from mpl_finance.py to src/mplfinance/original_flavor.py (It may also be affected by the location of the example data, but I'm guessing not.)

When I created the new repository mplfinance from the old repository mpl-finance, I copied in all of the commit history, and I made the above mentioned renames to keep the old api available (but at the same time make the old api "secondary"). However, I did not touch anything in the doc folder, thinking that, at some time in the future, either I, or someone else, would eventually get around to making it work. That future could be now. Can you help?

All the best. --Daniel

[edwinlima]

Hi,
Sorry for my late reply, I see what you mean, I've tried a couple of things but it would need more time to make it work, which unfortunately I don't have right now. Thanks though.

[DanielGoldfarb]

would need more time to make it work, which unfortunately I don't have right now.

Same here! I will leave this issue open for now as a reminder. I suppose one of us will get to this eventually ;-)