Skip to content

Commit

Permalink
fix: added sphinx-tabs requirement for docs and changed changelog name
Browse files Browse the repository at this point in the history
  • Loading branch information
jjjermiah committed Feb 4, 2024
1 parent f4f5cac commit e321180
Show file tree
Hide file tree
Showing 4 changed files with 149 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"autoapi.extension",
"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
"sphinx_tabs.tabs",
]
autoapi_dirs = ["../src"]

Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
myst-nb
sphinx-autoapi
sphinx-rtd-theme
sphinx-rtd-theme
sphinx-tabs
145 changes: 145 additions & 0 deletions docs/test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,151 @@ Usage
instance = YourClass(option1='value1', option2='value2')
instance.run_operation()
.. tabs::

.. tab:: Apples

Apples are green, or sometimes red.

.. tab:: Pears

Pears are green.

.. tab:: Oranges

Oranges are orange.

.. tabs::

.. tab:: Stars

.. tabs::

.. tab:: The Sun

The closest star to us.

.. tab:: Proxima Centauri

The second closest star to us.

.. tab:: Polaris

The North Star.

.. tab:: Moons

.. tabs::

.. tab:: The Moon

Orbits the Earth

.. tab:: Titan

Orbits Jupiter

.. tabs::

.. group-tab:: Linux

Linux tab content - tab set 1

.. group-tab:: Mac OSX

Mac OSX tab content - tab set 1

.. group-tab:: Windows

Windows tab content - tab set 1

.. tabs::

.. group-tab:: Linux

Linux tab content - tab set 2

.. group-tab:: Mac OSX

Mac OSX tab content - tab set 2

.. group-tab:: Windows

Windows tab content - tab set 2


.. tabs::

.. code-tab:: c

C Main Function

.. code-tab:: c++

C++ Main Function

.. code-tab:: py

Python Main Function

.. code-tab:: java

Java Main Function

.. code-tab:: julia

Julia Main Function

.. code-tab:: fortran

Fortran Main Function

.. code-tab:: r R

R Main Function

.. tabs::

.. code-tab:: c

int main(const int argc, const char **argv) {
return 0;
}
.. code-tab:: c++

int main(const int argc, const char **argv) {
return 0;
}
.. code-tab:: py

def main():
return

.. code-tab:: java

class Main {
public static void main(String[] args) {
}
}

.. code-tab:: julia

function main()
end

.. code-tab:: fortran

PROGRAM main
END PROGRAM main

.. code-tab:: r R

main <- function() {
return(0)
}
Configuration
-------------

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ commit_message = "chore(sem-ver): {version}"
patch_without_tag = true

[tool.semantic_release.changelog]
changelog_file = "docs/wiki/CHANGELOG.md"
changelog_file = "docs/markdowns/CHANGELOG.md"
exclude_commit_types = ["docs", "style", "refactor", "test", "chore"]


Expand Down

0 comments on commit e321180

Please sign in to comment.