How to Replicate Open edX Documentation on My Own Read the Docs Site

Community
1

Hello,

I’m trying to replicate the documentation from the Open edX project on my own Read the Docs site. Specifically, I want to mirror the Open edX Learner Guide to my own documentation site, which is hosted at https://yagnesh0707.readthedocs.io.

Steps I’ve Taken:

  1. Forked the Repository:
  1. Configured Read the Docs:
  • Created a Read the Docs project and linked it to my forked repository.
  1. Current Issue:
  • The documentation on my Read the Docs site is not displaying correctly. I see a blank page instead of the actual content.

I think there is probably something missing in the conf.py file or index.rst

You can view my GitHub repository here.

2

Hello @Yagnesh.

I didn’t try to build all the Open edX documentation, but I see that that repo has a lot of readthedocs.yml and config.py. I recommend that you try only to have the parts of the documentation you want in your repo and organize it to have a clear and straightforward readthedocs.yml and config.py.

I think you are using this edx-documentation/.readthedocs.yaml at master · Prem07077/edx-documentation · GitHub, but the doc you want is in another directory edx-documentation/en_us/open_edx_students/source/index.rst at master · openedx/edx-documentation · GitHub. I don’t know if that is the problem, but managing from less to more is easier.

Another thing that could help is the following examples of other repos:

I also found this documentation: Configuration file overview — Read the Docs user documentation.

Here is a quick guide I have every time I want to add documentation to a repo:

  • Enter the repository in the terminal
  • Create a virtualenv (E.g., virtualenv venv)
  • Activate the env (E.g., source venv/bin/activate)
  • Install sphinx (pip install sphinx)
  • Create a docs directory and enter it with the terminal
  • Run sphinx-quickstart to start a sphinx project
  • Run make html to compile the information
  • To view your documentation, run python -m http.server 8200 --directory build/html

I hope this helps you.

3 Likes
3

@mafermazu Thank you very much for the reply I will try that.

1 Like