Skip to content

Commit cf5a715

Browse files
committed
fix so all md format
1 parent 216416e commit cf5a715

File tree

3 files changed

+14
-99
lines changed

3 files changed

+14
-99
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pages/build/

pages/source/conf.py

Lines changed: 2 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -32,26 +32,14 @@
3232
else f"{copyright_first_year}-{current_year}"
3333
)
3434
copyright = f"{copyright_year_string}, {copyright_owners}. All rights reserved"
35-
36-
# The short X.Y version
3735
version = ""
38-
# The full version, including alpha/beta/rc tags
3936
release = ""
4037

41-
4238
# -- General configuration ---------------------------------------------------
4339

44-
# If your documentation needs a minimal Sphinx version, state it here.
45-
#
46-
# needs_sphinx = '1.0'
47-
48-
# Add any Sphinx extension module names here, as strings. They can be
49-
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
50-
# ones.
5140
extensions = [
5241
"sphinx.ext.autosummary",
5342
"sphinx.ext.autodoc",
54-
"sphinx.ext.mathjax",
5543
"sphinx.ext.viewcode",
5644
"sphinx.ext.napoleon",
5745
"sphinx.ext.intersphinx",
@@ -65,94 +53,31 @@
6553
napoleon_use_param = False
6654
napoleon_use_ivar = True
6755

68-
# Add any paths that contain templates here, relative to this directory.
69-
# templates_path = ["_templates"]
70-
71-
# The suffix(es) of source filenames.
72-
# You can specify multiple suffix as a list of string:
73-
#
74-
source_suffix = ['.rst', '.md']
75-
#source_suffix = ".md"
76-
77-
# The master toctree document.
56+
source_suffix = [".rst", ".md"]
7857
master_doc = "index"
7958

80-
# The language for content autogenerated by Sphinx. Refer to documentation
81-
# for a list of supported languages.
82-
#
83-
# This is also used if you do content translation via gettext catalogs.
84-
# Usually you set "language" from the command line for these cases.
8559
language = "en"
8660

87-
# List of patterns, relative to source directory, that match files and
88-
# directories to ignore when looking for source files.
89-
# This pattern also affects html_static_path and html_extra_path .
9061
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
9162

9263
# The name of the Pygments (syntax highlighting) style to use.
9364
pygments_style = "default"
9465

95-
9666
# -- Options for HTML output -------------------------------------------------
9767

98-
# The theme to use for HTML and HTML Help pages. See the documentation for
99-
# a list of builtin themes.
100-
#
10168
html_theme = "furo"
102-
# html_logo = "images/blaah"
103-
104-
# Theme options are theme-specific and customize the look and feel of a theme
105-
# further. For a list of options available for each theme, see the
106-
# documentation.
107-
#
108-
# html_theme_options = {}
10969
html_theme_options = {
11070
"light_logo": "ccpbiosim-dark-sq.png", # Your light mode logo file
11171
"dark_logo": "ccpbiosim-light-sq.png", # Your dark mode logo file
11272
}
11373

114-
# Add any paths that contain custom static files (such as style sheets) here,
115-
# relative to this directory. They are copied after the builtin static files,
116-
# so a file named "default.css" will overwrite the builtin "default.css".
11774
html_static_path = ["_static"]
11875

119-
# Custom sidebar templates, must be a dictionary that maps document names
120-
# to template names.
121-
#
122-
# The default sidebars (for documents that don't match any pattern) are
123-
# defined by theme itself. Builtin themes are using these templates by
124-
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
125-
# 'searchbox.html']``.
126-
#
127-
# html_sidebars = {}
128-
129-
130-
# -- Options for HTMLHelp output ---------------------------------------------
131-
13276
# Output file base name for HTML help builder.
13377
htmlhelp_basename = "ccpbiosim_doc"
13478

135-
13679
# -- Options for LaTeX output ------------------------------------------------
137-
138-
latex_elements = {
139-
# The paper size ('letterpaper' or 'a4paper').
140-
#
141-
# 'papersize': 'letterpaper',
142-
# The font size ('10pt', '11pt' or '12pt').
143-
#
144-
# 'pointsize': '10pt',
145-
# Additional stuff for the LaTeX preamble.
146-
#
147-
# 'preamble': '',
148-
# Latex figure (float) alignment
149-
#
150-
# 'figure_align': 'htbp',
151-
}
152-
153-
# Grouping the document tree into LaTeX files. List of tuples
154-
# (source start file, target name, title,
155-
# author, documentclass [howto, manual, or own class]).
80+
latex_elements = {}
15681
latex_documents = [
15782
(
15883
master_doc,
@@ -163,19 +88,10 @@
16388
),
16489
]
16590

166-
16791
# -- Options for manual page output ------------------------------------------
168-
169-
# One entry per manual page. List of tuples
170-
# (source start file, name, description, authors, manual section).
17192
man_pages = [(master_doc, "CCPBioSim", "CCPBioSim Developers Documentation", [author], 1)]
17293

173-
17494
# -- Options for Texinfo output ----------------------------------------------
175-
176-
# Grouping the document tree into Texinfo files. List of tuples
177-
# (source start file, target name, title, author,
178-
# dir menu entry, description, category)
17995
texinfo_documents = [
18096
(
18197
master_doc,
@@ -187,7 +103,6 @@
187103
),
188104
]
189105

190-
191106
# -- Extension configuration -------------------------------------------------
192107
def setup(app):
193108
app.add_css_file("custom.css")
Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
Welcome to CCPBioSim Developer Organisation
2-
===========================================
1+
# Welcome to CCPBioSim Developer Organisation
32

43
This GitHub organisation contains software, workshop material and many other types of repositories. These pages are aimed at developers, not users. They contain information about our development practices as well as details of which repositories are actively maintained and which are not.
54

65
This is currently a work in progress. Over time we wish to add things like roadmaps, dashboards, docs about coding etc etc.
76

8-
.. toctree::
9-
:maxdepth: 2
10-
:caption: Contents:
7+
```{toctree}
8+
---
9+
maxdepth: 2
10+
caption: Contents:
11+
---
12+
workshops-dash.md
13+
```
1114

12-
workshops-dash
15+
## Indices and tables
1316

14-
Indices and tables
15-
------------------
16-
17-
* :ref:`genindex`
18-
* :ref:`modindex`
19-
* :ref:`search`
17+
- {ref}`genindex`
18+
- {ref}`search`

0 commit comments

Comments
 (0)