Skip to content

Commit 8ed78d2

Browse files
johnmhoranjohnmhoran
committed
Begin restructuring #40
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
1 parent b0ca4e0 commit 8ed78d2

23 files changed

Lines changed: 198 additions & 80 deletions

‎docs/source/_static/theme_overrides.css‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,12 @@ div.custom-admonition-caution.admonition {
118118
/* note */
119119
.custom-admonition-note .admonition-title {
120120
color: #ffffff;
121+
/* color: #000000; */
121122
background: #3399ff;
122123
background: #006bb3;
124+
background: #cce5ff;
125+
background: #b3d7ff;
126+
background: #2196f3;
123127
border-radius: 5px 5px 0px 0px;
124128
}
125129
div.custom-admonition-note.admonition {
@@ -128,6 +132,8 @@ div.custom-admonition-note.admonition {
128132
background: #ffffff;
129133
border: solid 1px #e8e8e8;
130134
border: solid 1px #cccccc;
135+
/* border: solid 1px #80bdff; */
136+
/* border: solid 1px #2196f3; */
131137
border-radius: 5px;
132138
/* box-shadow: 5px 5px 18px #d8d8d8; */
133139
box-shadow: 1px 1px 5px 3px #d8d8d8;
@@ -137,9 +143,20 @@ div.custom-admonition-note.admonition {
137143
/* todo */
138144
.custom-admonition-todo .admonition-title {
139145
color: #000000;
146+
color: #cc0000;
140147
background: #cce6ff;
148+
background: #ffcc00;
149+
background: #ffeb99;
150+
background: #ccffff;
151+
background: #ffd9b3;
152+
background: #ffffff;
141153
border-radius: 5px 5px 0px 0px;
142154
border-bottom: solid 1px #99ccff;
155+
border-bottom: solid 1px #ffcc00;
156+
border-bottom: solid 1px #ffeb99;
157+
border-bottom: solid 1px #e8e8e8;
158+
border-bottom: solid 1px #ffd9b3;
159+
border-bottom: solid 1px #d8d8d8;
143160
}
144161
div.custom-admonition-todo.admonition {
145162
color: #000000;
@@ -148,6 +165,10 @@ div.custom-admonition-todo.admonition {
148165
border: solid 1px #e8e8e8;
149166
border: solid 1px #cccccc;
150167
border: solid 1px #99ccff;
168+
border: solid 1px #ffcc00;
169+
border: solid 1px #ffeb99;
170+
border: solid 1px #ffd9b3;
171+
border: solid 1px #cc0000;
151172
border-radius: 5px;
152173
/* box-shadow: 5px 5px 18px #d8d8d8; */
153174
box-shadow: 1px 1px 5px 3px #d8d8d8;
@@ -364,3 +385,31 @@ code, .rst-content tt, .rst-content code {
364385
margin-bottom: 0px;
365386
line-height: 24px;
366387
}
388+
389+
/* === */
390+
391+
/* this is used by the genindex added via layout.html (see source/_templates/) to sidebar toc */
392+
.reference.internal.toc-index {
393+
color: #d9d9d9;
394+
}
395+
396+
.reference.internal.toc-index.current {
397+
background-color: #ffffff;
398+
color: #000000;
399+
font-weight: bold;
400+
}
401+
402+
.toc-index-div {
403+
border-top: solid 1px #666666;
404+
margin-top: 10px;
405+
padding-top: 10px;
406+
}
407+
408+
/* The next 2 fix the poor vertical spacing in genindex.html (the alphabetized index) */
409+
.indextable.genindextable {
410+
margin-bottom: 20px;
411+
}
412+
413+
div.genindex-jumpbox {
414+
margin-bottom: 20px;
415+
}

‎docs/source/_templates/layout.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{% extends "!layout.html" %}
2+
3+
{% block menu %}
4+
{{ super() }}
5+
<div class="toc-index-div">
6+
<a href="{{pathto('genindex.html', 1)}}" class="reference internal toc-index">Index</a>
7+
</div>
8+
{% endblock %}

‎docs/source/aboutcode-docs/aboutcode_logo.svg‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/source/aboutcode-docs/home.rst‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/source/help.rst renamed to docs/source/aboutcode-project-overview.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
Help
2-
====
1+
==========================
2+
AboutCode Project Overview
3+
==========================
34

45
AboutCode is a suite of open source projects.
56

‎docs/source/aboutcode-toolkit/index.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
**AboutCode-Toolkit Documentation**
2-
===================================
1+
===============================
2+
AboutCode-Toolkit Documentation
3+
===============================
34

45
.. toctree::
56
:maxdepth: 2

‎docs/source/coding-principles/testing.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=======
2+
Testing
3+
=======
4+
5+
.. admonition:: ToDo
6+
:class: custom-admonition-todo
7+
8+
We need to create this content.

docs/source/aboutcode-docs/writing_good_commit_messages.rst renamed to docs/source/coding-principles/writing_good_commit_messages.rst

File renamed without changes.

‎docs/source/coding-toc.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
=================
2+
Coding Principles
3+
=================
4+
5+
.. admonition:: ToDo
6+
:class: custom-admonition-todo
7+
8+
We need a brief intro.
9+
10+
.. toctree::
11+
:maxdepth: 2
12+
13+
coding-principles/writing_good_commit_messages
14+
coding-principles/testing

docs/source/aboutcode-docs/contributor_project_ideas.rst renamed to docs/source/contributor_project_ideas.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _contributor_project_ideas:
22

3-
Contributor Project Ideas
4-
=========================
3+
===============================
4+
Contributor Project Ideas (old)
5+
===============================
56

67
.. _welcome_to_aboutcode:
78

0 commit comments

Comments
 (0)