Skip to content

Commit f7b558f

Browse files
authored
[DOC] Add contributor's guide to the docs (#234)
* add contributor guide to rendered docs * remove unused link * add contributors guide
1 parent 9c4c1ef commit f7b558f

File tree

5 files changed

+9
-3
lines changed

5 files changed

+9
-3
lines changed

CONTRIBUTING.md

-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ All types of contributions are encouraged and valued. See the [Table of Contents
2424
- [Improving The Documentation](#improving-the-documentation)
2525
- [Styleguides](#styleguides)
2626
- [Commit Messages](#commit-messages)
27-
- [Join The Project Team](#join-the-project-team)
2827

2928

3029
## Code of Conduct

docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
bokeh
22
jupyter_bokeh
3+
myst-parser
34
seaborn
45
plotly
56
ipython

docs/source/CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../CONTRIBUTING.md

docs/source/conf.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
# Add any Sphinx extension module names here, as strings. They can be extensions
5252
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
5353
extensions = [
54+
"myst_parser",
5455
"sphinx_copybutton",
5556
"sphinx_issues", # linking github issues, prs, users
5657
"sphinx_material",
@@ -110,7 +111,10 @@
110111
templates_path = ["_templates"]
111112

112113
# The suffix of source filenames.
113-
source_suffix = ".rst"
114+
source_suffix = {
115+
".rst": "restructuredtext",
116+
".md": "markdown",
117+
}
114118

115119
# The encoding of source files.
116120
# source_encoding = 'utf-8-sig'
@@ -120,7 +124,7 @@
120124

121125
# General information about the project.
122126
project = "mendeleev"
123-
copyright = "2024, Lukasz Mentel"
127+
copyright = "2025, Lukasz Mentel"
124128

125129
# Link to GitHub repo for github_issues extension
126130
issues_github_path = "lmmentel/mendeleev"

docs/source/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ the periodic table of elements.
2828
Data <data>
2929
Accessing data <data_access>
3030
Electronegativity <electronegativity>
31+
Contributing guide <CONTRIBUTING>
3132
API Reference <api/api>
3233
Bibliography <bibliography>
3334
Changes <changes_link>

0 commit comments

Comments
 (0)