Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • ketos ketos
  • Project information
    • Project information
    • Activity
    • Labels
    • Planning hierarchy
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 27
    • Issues 27
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • public_projects
  • ketosketos
  • Wiki
  • Sphinx Documentation guides

Sphinx Documentation guides · Changes

Page history
Update Sphinx Documentation guides authored Jun 10, 2022 by Bruno Padovese's avatar Bruno Padovese
Show whitespace changes
Inline Side-by-side
Sphinx-Documentation-guides.md
View page @ 576831ec
These are general notes on the styling of the project and things we need to be careful. These are general notes on the styling of the project and things we need to be careful.
Make sure to install sphinx and sphinx-rtd-theme first:
```
pip install sphinx
pip install sphinx-rtd-theme
```
1. We are using the Read the docs (rtd - https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html) styling for sphinx. I have altered a little bit of the layout.html of the original rtd theme to allow for 2 logos to be inserted as well as to allow for a link to the meridian website. You can find this layout in the _templates folder. 1. We are using the Read the docs (rtd - https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html) styling for sphinx. I have altered a little bit of the layout.html of the original rtd theme to allow for 2 logos to be inserted as well as to allow for a link to the meridian website. You can find this layout in the _templates folder.
......
Clone repository
  • Home
  • New release instructions
  • Sphinx Documentation guides