Closed xitij2000 closed 1 year ago
Thanks for the pull request, @xitij2000! Please note that it may take us up to several weeks or months to complete a review and merge your PR.
Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.
This is currently a draft pull request. When it is ready for our review and all tests are green, click "Ready for Review", or remove "WIP" from the title, as appropriate.
@feanil This repo seems to be using Python 2 and seems to be hosting its own copy of edx_theme. It is using Sphinx 1.5.2 while the current version is 6, and doesn't seem straightforward to upgrade.
Is this supposed to be archived? If not I think we'll need to have the docs built by Python 3 while the rest of the repo uses Python 2.
@bmtcril do you know the answers to @xitij2000 question? Is this repo something that should be archived?
My understanding is that 2U is maintaining this for at least their own pipelines, but I'm not sure at what level. The amazing @HassanJaveed84 is the last 2Uer that seems to have touched it so may have more details, but I don't think it's ready to be archived yet.
@feanil @bmtcril Sure. I think that clarifies things. I can see two options in the scope of the edx-sphinx-theme deprecation task then:
I'm on board for option 1 given the state of things
@xitij2000 Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.
The edx-sphinx theme is being deprecated, and replaced with sphinx-book-theme. This removes references to the deprecated theme and replaces them with the new standard theme for the platform.
Testing instructions:
make docs
and see that the docs are generated properly and use the sphinx-book-themeSee https://github.com/openedx/public-engineering/issues/200