Add support for multiple books in a single project

Desired feature

I have a software package that is composed of two separate parts: A C-based library (c-proj) and a python wrapper that builds upon this library (py-proj). The documentation for the two projects is found in the main proj repo of the project, but the documentation of c-proj and py-proj are very different, and each has its own separate _toc.yml file inside of their own separate folders. I would like to to be able to host both of the books on the same web site and to be able to switch easily between the c-proj and py-proj books.

A possible solution

One possible solution would be to put the documentation of each project into its own folder, and then add an index.html file that allows the user the switch between the two. The structure of the book would look something like this:

book
├── index.md
├── c-proj
│   ├── _toc.yml
├── py-proj
│   ├── _toc.yml

An alternative solution might be to build the sub-books in separate _build/html/c-proj, _build/html/py-proj folders, and then provide the option of choosing which index.html file should be used as the default (this would create a hard link to the index.html file). A drop down menu could then be added to the top of the page allowing to switch between the c-proj and py-proj books.

Multilingual support

Even though this feature request is related to hosting independent sub-books in a single repo, I suspect that the machinery for multiligual support might be similar. See https://github.com/executablebooks/jupyter-book/issues/223

[HealthyPear]

Any idea how to tell the book the same settings about logo and title that I have in the conf.py? I am using "logo_only": True, in conf.py and that works for the main page, but in the book the title (which is long) is crammed on the right between the logo and the sidebar limit

I found out how to remove it from the logo by adding

sphinx:
  config:
    html_theme_options:
      logo_only: True

to the book’s _config.yml, though it might be good to also state where to put it wrt to the logo

[HealthyPear]

Hmm - the new sphinx book theme actually does have some rough support for adding a header. Check out these instructions here: https://sphinx-book-theme.readthedocs.io/en/latest/customize/header.html

This seems to do the job! though I’ll need to learn how to do the styling

for reference now my custom css looks like this

iframe.book {
    width: 100%;
    height: 100%;
    border: none;
    position: fixed;
    top: 2em;
    bottom: 0;
    left: 0;
    z-index: 1000000;
}

.bd-sidebar {
    border: none;
    z-index: -100000;
}

Right now there’s no styling that is specific to the header, but perhaps over time we could add this in for common patterns. There’s a question of where to draw the line between this theme and the pydata theme 🤔

I understand - I think a proper solution where a book is inside another book should work better anyway…

Any idea how to tell the book the same settings about logo and title that I have in the conf.py? I am using "logo_only": True, in conf.py and that works for the main page, but in the book the title (which is long) is crammed on the right between the logo and the sidebar limit