diff --git a/docs/conf.py b/docs/conf.py index 16c782a..ddfd75a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -69,7 +69,6 @@ # The suffix of source filenames. source_suffix = [ - ".rst", ".md", ] diff --git a/docs/features/index.md b/docs/features/index.md new file mode 100644 index 0000000..21e118c --- /dev/null +++ b/docs/features/index.md @@ -0,0 +1,5 @@ +# ✨ Features + +## Some feature + +To be documented ... diff --git a/docs/features/index.rst b/docs/features/index.rst deleted file mode 100644 index 9187004..0000000 --- a/docs/features/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -✨ Features -************ - -Some feature ------------- - -To be documented ... diff --git a/docs/getting_started/concepts.md b/docs/getting_started/concepts.md new file mode 100644 index 0000000..5c72c5a --- /dev/null +++ b/docs/getting_started/concepts.md @@ -0,0 +1,3 @@ +# Basic Concepts and Naming Conventions + +To be documented ... diff --git a/docs/getting_started/concepts.rst b/docs/getting_started/concepts.rst deleted file mode 100644 index 8cb3afb..0000000 --- a/docs/getting_started/concepts.rst +++ /dev/null @@ -1,4 +0,0 @@ -Basic Concepts and Naming Conventions -===================================== - -To be documented ... diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md new file mode 100644 index 0000000..4663032 --- /dev/null +++ b/docs/getting_started/index.md @@ -0,0 +1,7 @@ +# 🚀 Getting Started + +```{toctree} +:maxdepth: 2 + +concepts +``` diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst deleted file mode 100644 index 65d7a5e..0000000 --- a/docs/getting_started/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -🚀 Getting Started -****************** - -.. toctree:: - :maxdepth: 2 - - concepts diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..fe1cf8d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,10 @@ +# Welcome to Intel HEX Tools documentation + +```{toctree} +:maxdepth: 2 + +getting_started/index +features/index +internals/index +about/index +``` diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 087a474..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -Welcome to Intel HEX Tools documentation -######################################## - -.. toctree:: - :maxdepth: 2 - - getting_started/index - features/index - internals/index - about/index diff --git a/docs/internals/index.md b/docs/internals/index.md new file mode 100644 index 0000000..330367f --- /dev/null +++ b/docs/internals/index.md @@ -0,0 +1,3 @@ +# 📚 Internals + +To be documented. diff --git a/docs/internals/index.rst b/docs/internals/index.rst deleted file mode 100644 index ca44359..0000000 --- a/docs/internals/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -📚 Internals -************ - -To be documented.