Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How does ReadtheDocs URL look like with multi projects after modifying makefile? #6

Open
sachin-suresh-rapyuta opened this issue Nov 6, 2022 · 1 comment

Comments

@sachin-suresh-rapyuta
Copy link

sachin-suresh-rapyuta commented Nov 6, 2022

As per the steps explained in Using Sphinx’s Makefile, PROJECT=dev make html can be used to build HTML locally. But, how to manage this on publishing to ReadtheDocs?

Say, I want to build and publish updates to dev and/or user projects, should I have to define the commands twice for 2 different projects? Something like below:

# Put your default project here.
PROJECT ?= user
BUILDDIR = _build/$(PROJECT)

PROJECT ?= dev
BUILDDIR = _build/$(PROJECT)

After publishing to ReadtheDocs, what does the URL for 2 different projects look like:

Is it:

  • readthedocs-hosted.com/en/latest/user/
  • readthedocs-hosted.com/en/latest/dev/ ?
@sachin-suresh-rapyuta sachin-suresh-rapyuta changed the title How does the URL look like with multi projects after modifying makefile? How does ReadtheDocs URL look like with multi projects after modifying makefile? Nov 6, 2022
@stsewd
Copy link
Member

stsewd commented Nov 7, 2022

But, how to manage this on publishing to ReadtheDocs?

You'll need to define an environment variable for each project, see https://sphinx-multiproject.readthedocs.io/en/latest/quickstart.html#importing-your-projects-on-read-the-docs.

After publishing to ReadtheDocs, what does the URL for 2 different projects look like:

You'll need to create a different project on Read the Docs for each sphinx project, so your documentation will be served as:

  • first-doc.readthedocs-hosted.com/en/latest
  • second-doc.readthedocs-hosted.com/en/latest

You can also make use of subprojects (https://docs.readthedocs.io/en/stable/subprojects.html) and have your docs like:

  • first-doc.readthedocs-hosted.com/en/latest
  • first-doc.readthedocs-hosted.com/projects/second/en/latest/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants