openstack/charm-guide
Code Issues Proposed changes

Redo home page

Browse Source 
To conform to documentation best practices add structure
to the home page (via the Diataxis framework). A Sphinx
extension is used to display panels.

The Release notes quadrant/panel will become the Reference
section once there is material to put there. The Release
notes will then fall under the Project hierarchy.

Add custom CSS to make the above panels respect the page's
text width.

Resurrect the search facility in a more direct manner.

Move the code of conduct reference to the home page.

Change-Id: I963d5f5b3e81b021747c0050fedd208e68ab920e
This commit is contained in:
Peter Matulis
2022-03-30 23:41:22 -04:00
parent 95ff808b31
commit 1fa01acd73
6 changed files with 85 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
requirements.txt
View File

@@ -7,5 +7,6 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
whereto>=0.3.0 # Apache-2.0
pyenchant
sphinxcontrib-spelling
pyenchant # GNU LGPL
sphinxcontrib-spelling # Doug Hellmann - permissions granted
sphinx-panels # MIT