[DOC] readthedocs builds are failing

[fkiraly]

It appears the readthedocs builds are failing.

Reasons are currently not known, possibly the linkage has broken since move to the new GH org, pyportfolio. This should be investigated.

Optionally, a CI doc build step with preview would also be nice.

[PredictiveManish]

PyPortfolioOpt/docs/index.rst

Lines 95 to 102 in 1db0896

	git clone https://github.com/robertmartin8/PyPortfolioOpt
	Alternatively, if you still want the convenience of a global ``from pypfopt import x``,
	you should try
	.. code-block:: text
	pip install -e git+https://github.com/robertmartin8/PyPortfolioOpt.git

the main docs has still the mention of robertmartin8/pyportfolioopt

which branch is being used by docs.

it's not whole issue but a part of the issue I think.

[PredictiveManish]

I think the branch for the RTD should be main, as direct updates will go to docs?

[fkiraly]

@PredictiveManish, these are just references that should be updated (but are still valid since GH forwards after rename) - and it is not what causes build failures, because it is part of the content rather than part of the setup.

[PredictiveManish]

Yes, you're right. I thought issue is with the repo link but in reality as per my understanding and what I can see from the build page from this link is that it's using master branch but now main branch should be used

https://app.readthedocs.org/projects/pyportfolioopt/builds/22764357/

[PredictiveManish]

I tried to build it locally too for better testing, and the issue remains the same as the master branch is absent but main got build. so I think for sure the issue is with the branch.

[PredictiveManish]

So now I think this issue mainly needs admin work on readthedocs project, if anything else is required, Please ping me. Jumping to any other issue.

[fkiraly]

not sure - what exactly needs to be changed?

[PredictiveManish]

not sure - what exactly needs to be changed?

Admin of the project on READTHEDOCS, has to make changes in the commands
from master -> main

I'm not sure if this will solve the issue completely but this is a major bottleneck from the proofs I observed.

[fkiraly]

Hm, I think the account might still be with @robertmartin8 since I cannot see the readthedocs acct for pyportfolioopt in my dashboard - can you kindly check, @robertmartin8?

[PredictiveManish]

@robertmartin8 Hi, I noticed the ReadTheDocs builds seem to be trying to build from the master branch, but the repository now uses main.

From the build page:
https://app.readthedocs.org/projects/pyportfolioopt/builds/22764357/

The logs mention master, which no longer exists, so that might be causing the failures. Since the RTD project might still be under your account, could you check if the default branch there is still set to master?

Just sharing what I observed while trying to reproduce the issue locally. Happy to help debug further if needed.