Skip to content

Commit

Permalink
Better looks and explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
wardweistra committed Jan 15, 2021
1 parent 74ca0e1 commit 2f69935
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,37 @@ This is the source code for the Firely documentation site, documenting the Firel

## Adding a new RTD subproject

1. Create empty public repository on Github.com: firely-docs-PROJECT-NAME
2. Create empty RTD project: sphinx-quickstart
3. Copy from another subproject like https://github.com/firelyTeam/firely-docs-firely-terminal:
* In root: build.bat, autobuild.bat, .gitignore
* In _templates: breadcrumbs.html (to customize top page name), layout.html (for Firely layout and logo link), searchbox.html (for accessibility label on search field)
* In _static: css/style.css, images/banner.png
1. Create empty public repository on Github.com: `firely-docs-PROJECT-NAME`

2. Create empty RTD project: `sphinx-quickstart`

3. Copy from another subproject like https://github.com/firelyTeam/firely-docs-firely-terminal, and don't change just for your subproject to avoid diversion:
* In root: `build.bat`, `autobuild.bat`, `.gitignore`
* In root: `README.md` and update it for your project
* In `_templates`: `breadcrumbs.html` (to customize top page name), `layout.html` (for Firely layout and logo link), `searchbox.html` (for accessibility label on search field)
* In _static: `css/style.css`, `images/banner.png`

4. In conf.py:
* Change theme: `html_theme = 'sphinx_rtd_theme'`
* Set theme options:

```
master_doc = 'index'
html_theme_options = {'navigation_depth': 3}```
html_theme_options = {'navigation_depth': 3}
```

* Set intersphinx settings to link to other RTD (sub)projects:

```
extensions = ['sphinx.ext.intersphinx']
intersphinx_mapping = {
'main_docs': ('https://docs.fire.ly', None),
}
```
5. Create a new project on readthedocs.org with an account with access to the [main project](https://readthedocs.org/projects/simplifier/) based on the new Github repo.

5. Create a new project on readthedocs.org with an account with access to the [main project](https://readthedocs.org/projects/simplifier/) based on the new Github repo. Add the Firely Google Analytics code (copied from the main project) under Admin > Advanced Settings.

6. Add the new project as [a Subproject to the main project](https://readthedocs.org/dashboard/simplifier/subprojects/). Note: Choose a pretty Alias/slug (Project-Name) because it will be shown as project name on the search page.

7. Add your project to the `intersphinx_mapping` of the main project and link it in the projects toctree. Note: toctree directive needs full urls and doesn't support intersphinx.

0 comments on commit 2f69935

Please sign in to comment.