diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 61ab24e8..3f64f68a 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -8,7 +8,7 @@ name: Deploy Jekyll site to Pages on: push: - branches: ["main"] + branches: ["master"] paths: - "docs/**" diff --git a/docs/1-user-guide/README.md b/docs/1-user-guide/README.md index f16392a3..cf15bb43 100644 --- a/docs/1-user-guide/README.md +++ b/docs/1-user-guide/README.md @@ -14,7 +14,7 @@ Guidelines on how to compile and install the library. * [Preliminaries](#preliminaries) * [Quick start](#quickstart) -* [Compiling and installing the library on Linu](#linux) +* [Compiling and installing the library on Linux](#linux) * [Compiling the library with Microsoft Visual C++](#MSVC) * [Compiling and running "Hello SLEEF"](#hello) * [Importing SLEEF into your project](#import) diff --git a/docs/6-contribute/README.md b/docs/6-contribute/README.md index 30a6e71e..b3120a6e 100644 --- a/docs/6-contribute/README.md +++ b/docs/6-contribute/README.md @@ -6,13 +6,12 @@ permalink: /6-contribute/ --- # Contribute to SLEEF -{:toc} ## Discussions If you have a question that does not necessarily require a change to SLEEF, such as asking how something works or how to contribute, please [open a -discussion](https://github.com/shibatch/sleef/discussions/new/choose). +discussion][discuss]. ## Templates @@ -23,26 +22,31 @@ you can by filing the provided forms. ## Report Bug -If you would like to report a bug in SLEEF, please [create a new -issue](https://github.com/shibatch/sleef/issues/new) and select [Report -Bugs](https://github.com/shibatch/sleef/issues/new?template=bug_report.md). -You can also suggest a fix by [submitting a pull -request](https://github.com/shibatch/sleef/pulls) on GitHub. +If you would like to report a bug in SLEEF, please [create a new issue][issues] +and select [Report Bug][bug]. + +You can also suggest a fix by [submitting a pull request][pulls] on GitHub. ## Request Feature If you would like to request a feature or a change to SLEEF, please [create a -new issue](https://github.com/shibatch/sleef/issues/new) and select [Request -Features](https://github.com/shibatch/sleef/issues/new?template=feature_request.md). +new issue][issues] and select [Request Feature][feature]. ## Request Documentation If you would like to report an issue or request a change to the documentation, -please [create a new issue](https://github.com/shibatch/sleef/issues/new) and -select [Request -Docs](https://github.com/shibatch/sleef/issues/new?template=docs_request.md). +please [create a new issue][issues] and select [Request Docs][docs]. ## Pull Requests If you would like to suggest a fix or any change to SLEEF, please [submit a -pull request](https://github.com/shibatch/sleef/pulls) on GitHub. +pull request][pulls] on GitHub. + + + +[discuss]: https://github.com/shibatch/sleef/discussions/new/choose +[issues]: https://github.com/shibatch/sleef/issues/new/choose +[bug]: https://github.com/shibatch/sleef/issues/new?template=bug_report.md +[feature]: https://github.com/shibatch/sleef/issues/new?template=feature_request.md +[docs]: https://github.com/shibatch/sleef/issues/new?template=docs_request.md +[pulls]: https://github.com/shibatch/sleef/pulls diff --git a/docs/_config.yml b/docs/_config.yml index 692f8a4f..4d0c5cc1 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,7 +1,7 @@ title: SLEEF Vectorized Math Library description: Vectorized C99 math functions across popular platforms and architectures. logo: img/sleef-logo-notext.svg -favicon_ico: img/favicon.png +favicon_ico: "/img/favicon.ico" theme: just-the-docs footer_content: "Copyright © 2010-2024 SLEEF Project, Naoki Shibata and contributors. SLEEF is open-source software and is distributed under the Boost Software License, Version 1.0." diff --git a/docs/img/favicon.png b/docs/img/favicon.ico similarity index 100% rename from docs/img/favicon.png rename to docs/img/favicon.ico diff --git a/docs/sleef.css b/docs/sleef.css deleted file mode 100644 index a0282ddb..00000000 --- a/docs/sleef.css +++ /dev/null @@ -1,87 +0,0 @@ -p.funcname { - font-family: "Times New Roman", times, serif; - font-size:1.2em; - font-weight: normal; - - margin-top: 0.3cm; - margin-bottom: 0.3cm; - - margin-left: 0.0cm; - text-indent:0pt; -} - -p.header { - font-family: arial, sansserif; - font-size:1.1em; - font-weight: bold; - margin-top: 1.0cm; - margin-bottom: 0.3cm; - - margin-left: 0.0cm; - text-indent:0pt; -} - -p.synopsis { - font-family: Ubuntu, arial, sansserif; - font-size:1.0em; - font-weight: normal; - margin-top: 0.3cm; - margin-bottom: 0.3cm; - margin-left: 0.6cm; - margin-right: 0.2cm; - padding-left: 0.1cm; - padding-right: 0.1cm; - text-indent:0pt; -} - -p.footer { - color:#808080; - font-family: "Times New Roman", times, serif; - font-weight: normal; - font-style: normal; - font-size:0.7em; - - text-align:center; - margin-top: 1.6cm; -} - -pre.command { - font-family: Consolas, Courier, sansserif; - font-size: 12pt; - background-color:#000000; - color:#d0d0d0; - margin: 1.5em 0.5cm 2.5em 0.5cm; - padding: 0.1cm 0.2cm 0.1cm 0.2cm; - box-shadow: 2px 2px 2px #888; - white-space: pre-wrap; -} - -pre.white { - background-color:white; - color:black; - font-family: Ubuntu, arial, sansserif; -} - -i.var { - font-family: "Times New Roman", times, serif; - font-weight: bold; - color:#a00000; -} - -i.math { - font-family: "Times New Roman", times, serif; - font-weight: normal; - font-style:normal; -} - -b.func { - font-family: Ubuntu, arial, sansserif; - font-weight: normal; - color:#008040; -} - -b.type { - font-family: Ubuntu, arial, sansserif; - font-weight: normal; - color:#0050a0; -} diff --git a/docs/texlike.css b/docs/texlike.css deleted file mode 100644 index f7020839..00000000 --- a/docs/texlike.css +++ /dev/null @@ -1,241 +0,0 @@ -body { - margin-left: 1.5cm; - border-left: 0.0cm; - padding-left: 0.0cm; - - margin-right: 1.5cm; - border-right: 0.0cm; - padding-right: 0.0cm; - - margin-top: 1.0cm; - padding-top: 0.1cm; - margin-bottom: 0.5cm; - padding-bottom: 0.1cm; - - font-size:12.5pt; -} - -h1 { - font-family: arial, sansserif; - font-weight: bold; - font-style: italic; - font-size:1.8em; - - margin-top: 0.8cm; - - margin-left: 0.0cm; -} - -h2 { - font-family: arial, sansserif; - font-weight: bold; - font-style: normal; - font-size:1.6em; - - margin-top: 2.0cm; - margin-bottom: 0.5cm; - - margin-left: 0.0cm; -} - -h3 { - font-family: arial, sansserif; - font-weight: bold; - font-style: normal; - font-size:1.2em; - - margin-top: 0.9cm; - margin-bottom: 0.5cm; - - margin-left: 0.0cm; -} - -h4 { - font-family: arial, sansserif; - font-weight: bold; - font-style: normal; - - margin-top: 0.7cm; - margin-left: 0.0cm; - margin-bottom: 0.2cm; - padding-bottom: 0.0cm; -} - -p { - font-family: "Times New Roman", times, serif; - font-weight: normal; - font-style: normal; - - margin-top: 0.0cm; - padding-top: 0.0cm; - margin-bottom: 0.0cm; - padding-bottom: 0.0cm; - - text-indent:16pt; - - margin-left: 0.0cm; -} - -p.noindent { - text-indent:0pt; -} - -span.normal { - font-family: "Times New Roman", times, serif; - font-weight: normal; - font-style: normal; -} - -ul { - list-style-type: disc; - - font-family: "Times New Roman", times, serif; - font-weight: normal; - font-style: normal; - - margin-top: 0.0cm; - padding-top: 0.0cm; - margin-bottom: 0.0cm; - padding-bottom: 0.0cm; - margin-left: 0.8cm; - padding-left: 0.0cm; -} - -ul.circle { - list-style-type: circle; -} - -ul.square { - list-style-type: square; -} - -ul.none { - list-style-type: none; - margin-left: 0.0cm; -} - -ol { - font-family: "Times New Roman", serif; - font-weight: normal; - font-style: normal; - - margin-left: 0.8cm; - padding-left: 0.0cm; -} - - -a:link { - margin-left: 0cm; - color: black; - text-decoration: none; -} - -a:visited { - margin-left: 0cm; - color: black; - text-decoration: none; -} - -a:hover { - margin-left: 0cm; - color: black; - text-decoration: underline; -} - -a:article { - margin-left: 0cm; - color: black; - text-decoration: none; -} - -a.underlined:link { - text-decoration: underline; -} - -a.nothing:hover { - text-decoration: none; -} - -i { - font-family: "Times New Roman", times, serif; - font-weight: normal; -} - -b { - font-family: arial, sansserif; - font-weight: normal; -} - -hr { - margin-top: 0.8cm; - margin-bottom: 0.5cm; - padding-top: 0cm; - padding-bottom: 0cm; -} - -// - -table { - margin-left:auto; - margin-right:auto; -} - -td.caption { font-family: times, serif; color: black; } -td { font-family: times, serif; } - -table.lt { border-collapse: collapse; border-style: none; } -td.lt- { margin: 0px; padding: 4px; padding-left:0.3cm; padding-right:0.3cm; border-width: 1px; border-style: none; padding-left=0.2cm; padding-right=0.2cm; } -td.lt-r { margin: 0px; padding: 4px; padding-left:0.3cm; padding-right:0.3cm; border-style: none; border-right-style: solid; border-width: 1px; border-color: black; } -td.lt-l { margin: 0px; padding: 4px; padding-left:0.3cm; padding-right:0.3cm; border-style: none; border-left-style: solid; border-width: 1px; border-color: black; } -td.lt-lr { margin: 0px; padding: 4px; padding-left:0.3cm; padding-right:0.3cm; border-style: none; border-right-style: solid; border-left-style: solid; border-width: 1px; border-color: black; } -td.lt-b { margin: 0px; padding: 4px; padding-left:0.3cm; padding-right:0.3cm; border-style: none; border-bottom-style: solid; border-width: 1px; border-color: black; } -td.lt-hl { margin: 0px; border-style: none; border-bottom-style: solid; border-width: 1px; border-color: black; height: 0px; } -td.lt-bl { margin: 0px; padding: 4px; padding-left:0.3cm; padding-right:0.3cm; border-style: none; border-bottom-style: solid; border-left-style: solid; border-width: 1px; border-color: black; } -td.lt-br { margin: 0px; padding: 4px; padding-left:0.3cm; padding-right:0.3cm; border-style: none; border-bottom-style: solid; border-right-style: solid; border-width: 1px; border-color: black; } -td.lt-blr { margin: 0px; padding: 4px; padding-left:0.3cm; padding-right:0.3cm; border-style: none; border-bottom-style: solid; border-left-style: solid; border-right-style: solid; border-width: 1px; border-color: black; } - -// - -pre.white { - font-family: arial, sansserif; - font-size:1.0em; - font-weight: normal; - background-color:white; - overflow: auto; - - margin: 0.6cm; - margin-top: 1.0cm; - padding: 0.1cm; - color:black; -} - -pre.code { - font-family:arial, sansserif; - font-size:9pt; - font-weight: normal; - background-color:#fbf8ef; - box-shadow: 3px 3px 3px #aaa; - overflow: auto; - - margin: 1.0cm 1.5cm 1.0cm 1.5cm; - padding: 1em 1em 2em 1.1em; - counter-reset: line; - color:black; -} - -code { - font-family:"Consolas", arial, sansserif; - font-size:9pt; - counter-increment:line; -} - -code:before { - content: counter(line); - display: inline-block; - border-right: 1px solid #c0a0a0; - padding: 0 0.5em 0 0.5em; - margin-right: 0.5em; - min-width: 2em; - text-align: right; - font-size:9pt; -}