Skip to content

Commit

Permalink
update the layout.html to add proper source suffix for edit page
Browse files Browse the repository at this point in the history
  • Loading branch information
Thecarisma committed Sep 12, 2020
1 parent 1a37c9b commit 0cd48d6
Show file tree
Hide file tree
Showing 18 changed files with 121 additions and 11 deletions.
7 changes: 7 additions & 0 deletions test/confs/clear.conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@

html_theme_path = [themata.get_html_theme_path()]

extensions = ['recommonmark']
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

html_theme_options = {
'project_icon': "https://github.com/Thecarisma/themata/raw/main/docs/images/themata.png",
'has_left_sidebar': True,
Expand Down
7 changes: 7 additions & 0 deletions test/confs/fandango.conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@

html_theme_path = [themata.get_html_theme_path()]

extensions = ['recommonmark']
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

html_theme_options = {
'project_icon': "https://github.com/Thecarisma/themata/raw/main/docs/images/themata.png",
'has_right_sidebar': True,
Expand Down
7 changes: 7 additions & 0 deletions test/confs/fluid.conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@

html_theme_path = [themata.get_html_theme_path()]

extensions = ['recommonmark']
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

html_theme_options = {
'project_icon': "https://github.com/Thecarisma/themata/raw/main/docs/images/themata.png",
'has_left_sidebar': True,
Expand Down
7 changes: 7 additions & 0 deletions test/confs/garri.conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@

html_theme_path = [themata.get_html_theme_path()]

extensions = ['recommonmark']
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

html_theme_options = {
'sidebar_position': 'right',
'has_sidebar': True,
Expand Down
7 changes: 7 additions & 0 deletions test/confs/hackish.conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@

html_theme_path = [themata.get_html_theme_path()]

extensions = ['recommonmark']
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

html_theme_options = {
'project_icon': "https://github.com/Thecarisma/themata/raw/main/docs/images/themata.png",
'has_left_sidebar': True,
Expand Down
7 changes: 7 additions & 0 deletions test/confs/milkish.conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@

html_theme_path = [themata.get_html_theme_path()]

extensions = ['recommonmark']
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

html_theme_options = {
'project_icon': "https://github.com/Thecarisma/themata/raw/main/docs/images/themata.png",
'has_left_sidebar': True,
Expand Down
7 changes: 7 additions & 0 deletions test/confs/sugar.conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@

html_theme_path = [themata.get_html_theme_path()]

extensions = ['recommonmark']
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

html_theme_options = {
'project_icon': "https://github.com/Thecarisma/themata/raw/main/docs/images/themata.png",
'has_left_sidebar': True,
Expand Down
7 changes: 7 additions & 0 deletions test/confs/water.conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@

html_theme_path = [themata.get_html_theme_path()]

extensions = ['recommonmark']
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

html_theme_options = {
'project_icon': "https://github.com/Thecarisma/themata/raw/main/docs/images/themata.png",
'has_left_sidebar': True,
Expand Down
1 change: 1 addition & 0 deletions test/test_rst/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
/test1.left
/test1.right
/leftpage
/testmarkdown



Expand Down
53 changes: 53 additions & 0 deletions test/test_rst/testmarkdown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@

# libcester

A robust header only unit testing framework for C programming language. Support function mocking, memory leak detection, crash report.

cester is a header only automated testing framework for the C programming language, it requires no dependency and can be downloaded and used in a project immediately. Works on various platorms including embedded systems and compatible with various compilers. Allows shared instance `TestInstance` object in which each test cases can use to share data and access the command line arguments.

```c
#include <exotic/cester.h>

CESTER_TEST(test_one, inst,
cester_assert_equal(NULL, ((void*)0));
)
```

The test results can be outputed as various format JunitXML, Test Anything Protocol, Test Anything Protocol Version 13 and text. Visit [https://exoticlibraries.github.io/libcester/docs/](https://exoticlibraries.github.io/libcester/docs/) for documentation and tutorials.
___

## Table of content
- [Standards Compliance and Portability](#standards-compliance-and-portability)
- [Installation](#installation)
- [Install](#install)
- [Windows](#windows)
- [Linux](#linux)
- [Other platforms](#other-platforms)
- [Documentation](#documentation)
- [Usage](#usage)
- [Writing and Running test](#writing-test)
- [Cester options](#cester-options)
- [Macros](#macros)
- [Mocking](#mocking)
- [FAQ](#faq)
- [No test case detected](#no-test-case-detected)
- [How it works](#how-it-works)
- [Contributing](#contributing)
- [References](#references)
- [License](#license)

## Standards Compliance and Portability

The project is compliant with the original C language specification ISO/IEC 9899:1990 and the first POSIX specification IEEE Std 1003.1-1988 which ensures the project compatibility in various environments. It also makes use of features in the newer revisions ISO/IEC 9899:1999 and IEEE Std 1003.1-2001 whenever possible.

Even though the project is designed for C, but also works with C++ as it is compatible with C++98 Standard (ISO/IEC 14882:1998), C++03 Standard (ISO/IEC 14882:2003) and C++11 Standard (ISO/IEC 14882:2011).

The project can be used with any C or C++ compiler. There are optional macros and options that can be used to attain the desired output in the case of undesired results.

## Installation

If you install the library file `cester.h` using any of the commands below, it can be included in your test like `<exotic/cester.h>`.

### Windows

Install the library using powershell. It auto detect your insalled C and C++ compilers include directory and install libcester into the include folder. Execute the command in powershell as admin.
2 changes: 1 addition & 1 deletion themata/clear/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h2>Next topic</h2>
<h2>This Page</h2>
<a href="{{ pathto('_sources/', 1) }}{{ sourcename }}">Show source</a>
{% if theme_source_root != '' %}
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}.rst">{{ theme_source_root_edit_text }}</a>
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}">{{ theme_source_root_edit_text }}</a>
{% endif %}
{% endif %}
</div>
Expand Down
2 changes: 1 addition & 1 deletion themata/fandango/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h2>Next topic</h2>
<h2>This Page</h2>
<a href="{{ pathto('_sources/', 1) }}{{ sourcename }}">Show source</a>
{% if theme_source_root != '' %}
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}.rst">{{ theme_source_root_edit_text }}</a>
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}">{{ theme_source_root_edit_text }}</a>
{% endif %}
{% endif %}
</div>
Expand Down
4 changes: 2 additions & 2 deletions themata/fluid/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
{% if (pagename != 'index') or (pagename == 'index' and theme_show_navigators_in_index == True) %}
<div class="navigation">
{% if theme_source_root != '' %}
<a class="reference navigator" style="float:left;" href="{{ theme_source_root }}/{{ pagename }}.rst"><i class="fa fa-pen"></i>{{ theme_source_root_edit_text }}</a>
<a class="reference navigator" style="float:left;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}"><i class="fa fa-pen"></i>{{ theme_source_root_edit_text }}</a>
{% endif %}
<a class="reference navigator" style="float:left;" href="{{ pathto('genindex') }}"><i class="fa fa-book"></i>Index</a>

Expand Down Expand Up @@ -119,7 +119,7 @@ <h2>Next topic</h2>
<h2>This Page</h2>
<a href="{{ pathto('_sources/', 1) }}{{ sourcename }}">Show source</a>
{% if theme_source_root != '' %}
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}.rst">{{ theme_source_root_edit_text }}</a>
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}">{{ theme_source_root_edit_text }}</a>
{% endif %}
{% endif %}
</div>
Expand Down
2 changes: 1 addition & 1 deletion themata/garri/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3>This Page</h3>
<ul class="this-page-menu">
<li><a rel="nofollow" href="{{ pathto('_sources/', 1) }}{{ sourcename }}">Show source</a></li>
{% if theme_source_root != '' %}
<li><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}.rst">{{ theme_source_root_edit_text }}</a></li>
<li><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}">{{ theme_source_root_edit_text }}</a></li>
{% endif %}
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion themata/hackish/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ <h2>Next topic</h2>
<h2>This Page</h2>
<a href="{{ pathto('_sources/', 1) }}{{ sourcename }}">Show source</a>
{% if theme_source_root != '' %}
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}.rst">{{ theme_source_root_edit_text }}</a>
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}">{{ theme_source_root_edit_text }}</a>
{% endif %}
{% endif %}
</div>
Expand Down
4 changes: 2 additions & 2 deletions themata/milkish/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
{% if (pagename != 'index') or (pagename == 'index' and theme_show_navigators_in_index == True) %}
<div class="navigation">
{% if theme_source_root != '' %}
<a class="reference navigator" style="float:left;" href="{{ theme_source_root }}/{{ pagename }}.rst"><i class="fa fa-pen"></i>{{ theme_source_root_edit_text }}</a>
<a class="reference navigator" style="float:left;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}"><i class="fa fa-pen"></i>{{ theme_source_root_edit_text }}</a>
{% endif %}
<a class="reference navigator" style="float:left;" href="{{ pathto('genindex') }}"><i class="fa fa-book"></i>Index</a>

Expand Down Expand Up @@ -114,7 +114,7 @@ <h2>Next topic</h2>
<h2>This Page</h2>
<a href="{{ pathto('_sources/', 1) }}{{ sourcename }}">Show source</a>
{% if theme_source_root != '' %}
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}.rst">{{ theme_source_root_edit_text }}</a>
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}">{{ theme_source_root_edit_text }}</a>
{% endif %}
{% endif %}
</div>
Expand Down
4 changes: 2 additions & 2 deletions themata/sugar/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
{% if (pagename != 'index') or (pagename == 'index' and theme_show_navigators_in_index == True) %}
<div class="navigation">
{% if theme_source_root != '' %}
<a class="reference navigator" style="float:left;" href="{{ theme_source_root }}/{{ pagename }}.rst"><i class="fa fa-pen"></i>{{ theme_source_root_edit_text }}</a>
<a class="reference navigator" style="float:left;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}"><i class="fa fa-pen"></i>{{ theme_source_root_edit_text }}</a>
{% endif %}
<a class="reference navigator" style="float:left;" href="{{ pathto('genindex') }}"><i class="fa fa-book"></i>Index</a>

Expand Down Expand Up @@ -130,7 +130,7 @@ <h2>Next topic</h2>
<h2>This Page</h2>
<a href="{{ pathto('_sources/', 1) }}{{ sourcename }}">Show source</a>
{% if theme_source_root != '' %}
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}.rst">{{ theme_source_root_edit_text }}</a>
<br/><a style="line-height: 25px;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}">{{ theme_source_root_edit_text }}</a>
{% endif %}
{% endif %}
</div>
Expand Down
2 changes: 1 addition & 1 deletion themata/water/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
{% if (pagename != 'index') or (pagename == 'index' and theme_show_navigators_in_index == True) %}
<div class="navigation">
{% if theme_source_root != '' %}
<a class="reference navigator" style="float:left;" href="{{ theme_source_root }}/{{ pagename }}.rst"><i class="fa fa-pen"></i>{{ theme_source_root_edit_text }}</a>
<a class="reference navigator" style="float:left;" href="{{ theme_source_root }}/{{ pagename }}{{ page_source_suffix }}"><i class="fa fa-pen"></i>{{ theme_source_root_edit_text }}</a>
{% endif %}
<a class="reference navigator" style="float:left;" href="{{ pathto('genindex') }}"><i class="fa fa-book"></i>Index</a>

Expand Down

0 comments on commit 0cd48d6

Please sign in to comment.