From 7b3ed411dbac76aa40adff6fb6c0bd3dfa5928ba Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Thu, 16 Mar 2023 21:54:14 -0600 Subject: [PATCH] Documentation update for Read the Docs Standardize hipSPARSE documentation builds (#316) Add dependabot config and pin rocm-docs-core (#318) Bump rocm-docs-core from 0.2.0 to 0.6.0 in /docs/.sphinx (#320) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.2.0 to 0.6.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/commits/v0.6.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump rocm-docs-core from 0.6.0 to 0.7.1 in /docs/.sphinx (#321) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.6.0 to 0.7.1. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.6.0...v0.7.1) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Update documentation requirements (#324) Bump requests from 2.28.2 to 2.31.0 in /docs/.sphinx (#326) Bumps [requests](https://github.com/psf/requests) from 2.28.2 to 2.31.0. - [Release notes](https://github.com/psf/requests/releases) - [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md) - [Commits](https://github.com/psf/requests/compare/v2.28.2...v2.31.0) --- updated-dependencies: - dependency-name: requests dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump rocm-docs-core from 0.11.0 to 0.12.0 in /docs/.sphinx (#329) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.11.0 to 0.12.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.11.0...v0.12.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump rocm-docs-core from 0.12.0 to 0.13.1 in /docs/.sphinx (#332) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.12.0 to 0.13.1. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.12.0...v0.13.1) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Remove old docs system workflow (#333) This file will no longer be relevant with the transition to a new docs system in ROCm 5.6. Bump rocm-docs-core from 0.13.1 to 0.13.2 in /docs/.sphinx (#334) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.13.1 to 0.13.2. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.13.1...v0.13.2) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump rocm-docs-core from 0.13.2 to 0.13.3 in /docs/.sphinx (#337) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.13.2 to 0.13.3. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.13.2...v0.13.3) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump cryptography from 40.0.2 to 41.0.0 in /docs/.sphinx (#339) Bumps [cryptography](https://github.com/pyca/cryptography) from 40.0.2 to 41.0.0. - [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst) - [Commits](https://github.com/pyca/cryptography/compare/40.0.2...41.0.0) --- updated-dependencies: - dependency-name: cryptography dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump rocm-docs-core from 0.13.3 to 0.13.4 in /docs/.sphinx (#342) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.13.3 to 0.13.4. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.13.3...v0.13.4) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/dependabot.yml | 12 ++ .gitignore | 14 +- .readthedocs.yaml | 14 ++ README.md | 12 ++ docs/{ => .doxygen}/Doxyfile | 4 +- docs/{ => .doxygen}/modules.dox | 0 docs/.sphinx/_toc.yml.in | 3 + docs/.sphinx/requirements.in | 1 + docs/.sphinx/requirements.txt | 145 ++++++++++++++++++ docs/conf.py | 14 ++ docs/{source => }/index.rst | 0 docs/rocm.jpg | Bin 6761 -> 0 bytes docs/run_doc.sh | 22 --- docs/run_doxygen.sh | 14 -- docs/source/Makefile | 20 --- docs/source/_static/theme_overrides.css | 13 -- docs/source/conf.py | 191 ------------------------ docs/source/requirements.txt | 3 - docs/{source => }/usermanual.rst | 0 19 files changed, 211 insertions(+), 271 deletions(-) create mode 100644 .github/dependabot.yml create mode 100644 .readthedocs.yaml rename docs/{ => .doxygen}/Doxyfile (99%) rename docs/{ => .doxygen}/modules.dox (100%) create mode 100644 docs/.sphinx/_toc.yml.in create mode 100644 docs/.sphinx/requirements.in create mode 100644 docs/.sphinx/requirements.txt create mode 100644 docs/conf.py rename docs/{source => }/index.rst (100%) delete mode 100644 docs/rocm.jpg delete mode 100755 docs/run_doc.sh delete mode 100755 docs/run_doxygen.sh delete mode 100644 docs/source/Makefile delete mode 100644 docs/source/_static/theme_overrides.css delete mode 100644 docs/source/conf.py delete mode 100644 docs/source/requirements.txt rename docs/{source => }/usermanual.rst (100%) diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..ada22f1b --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "pip" # See documentation for possible values + directory: "/" # Location of package manifests + open-pull-requests-limit: 10 + schedule: + interval: "daily" diff --git a/.gitignore b/.gitignore index 233e4ef5..ee5f3b44 100644 --- a/.gitignore +++ b/.gitignore @@ -35,12 +35,14 @@ tags # Editors .vscode -# build-in-source directory -build - -# doc directory -docBin -_build +# build-in-source directory and documentation artifacts +build/ +_build/ +_images/ +_static/ +_templates/ +_toc.yml +docBin/ # matrices *.csr diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..43a0890c --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,14 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +sphinx: + configuration: docs/conf.py + +formats: [htmlzip] + +python: + version: "3.8" + install: + - requirements: docs/.sphinx/requirements.txt diff --git a/README.md b/README.md index dc18a2e3..b2082b80 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,18 @@ # hipSPARSE hipSPARSE is a SPARSE marshalling library, with multiple supported backends. It sits between the application and a 'worker' SPARSE library, marshalling inputs into the backend library and marshalling results back to the application. hipSPARSE exports an interface that does not require the client to change, regardless of the chosen backend. Currently, hipSPARSE supports [rocSPARSE](https://github.com/ROCmSoftwarePlatform/rocSPARSE) and [cuSPARSE](https://developer.nvidia.com/cusparse) as backends. +## Documentation + +Run the steps below to build documentation locally. + +``` +cd docs + +pip3 install -r .sphinx/requirements.txt + +python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html +``` + ## Installing pre-built packages Download pre-built packages either from [ROCm's package servers](https://rocm.github.io/install.html#installing-from-amd-rocm-repositories) or by clicking the github releases tab and manually downloading, which could be newer. Release notes are available for each release on the releases tab. * `sudo apt update && sudo apt install hipsparse` diff --git a/docs/Doxyfile b/docs/.doxygen/Doxyfile similarity index 99% rename from docs/Doxyfile rename to docs/.doxygen/Doxyfile index 0e47a0f6..ebf07520 100644 --- a/docs/Doxyfile +++ b/docs/.doxygen/Doxyfile @@ -51,7 +51,7 @@ PROJECT_BRIEF = "prototype interfaces compatible with ROCm platform and # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ./rocm.jpg +PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -829,7 +829,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../library/include +INPUT = ../../library/include # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/docs/modules.dox b/docs/.doxygen/modules.dox similarity index 100% rename from docs/modules.dox rename to docs/.doxygen/modules.dox diff --git a/docs/.sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in new file mode 100644 index 00000000..38918736 --- /dev/null +++ b/docs/.sphinx/_toc.yml.in @@ -0,0 +1,3 @@ +# Anywhere {branch} is used, the branch name will be substituted. +# These comments will also be removed. +root: index diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in new file mode 100644 index 00000000..7f2c40a8 --- /dev/null +++ b/docs/.sphinx/requirements.in @@ -0,0 +1 @@ +rocm-docs-core==0.13.4 diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt new file mode 100644 index 00000000..48b1769e --- /dev/null +++ b/docs/.sphinx/requirements.txt @@ -0,0 +1,145 @@ +# +# This file is autogenerated by pip-compile with Python 3.8 +# by the following command: +# +# pip-compile requirements.in +# +accessible-pygments==0.0.3 + # via pydata-sphinx-theme +alabaster==0.7.13 + # via sphinx +babel==2.12.1 + # via + # pydata-sphinx-theme + # sphinx +beautifulsoup4==4.11.2 + # via pydata-sphinx-theme +breathe==4.34.0 + # via rocm-docs-core +certifi==2022.12.7 + # via requests +cffi==1.15.1 + # via + # cryptography + # pynacl +charset-normalizer==3.1.0 + # via requests +click==8.1.3 + # via sphinx-external-toc +cryptography==41.0.0 + # via pyjwt +deprecated==1.2.13 + # via pygithub +docutils==0.19 + # via + # breathe + # myst-parser + # pydata-sphinx-theme + # sphinx +fastjsonschema==2.16.3 + # via rocm-docs-core +gitdb==4.0.10 + # via gitpython +gitpython==3.1.31 + # via rocm-docs-core +idna==3.4 + # via requests +imagesize==1.4.1 + # via sphinx +jinja2==3.1.2 + # via + # myst-parser + # sphinx +linkify-it-py==1.0.3 + # via myst-parser +markdown-it-py==2.2.0 + # via + # mdit-py-plugins + # myst-parser +markupsafe==2.1.2 + # via jinja2 +mdit-py-plugins==0.3.5 + # via myst-parser +mdurl==0.1.2 + # via markdown-it-py +myst-parser[linkify]==1.0.0 + # via rocm-docs-core +packaging==23.0 + # via + # pydata-sphinx-theme + # sphinx +pycparser==2.21 + # via cffi +pydata-sphinx-theme==0.13.3 + # via + # rocm-docs-core + # sphinx-book-theme +pygithub==1.58.1 + # via rocm-docs-core +pygments==2.14.0 + # via + # accessible-pygments + # pydata-sphinx-theme + # sphinx +pyjwt[crypto]==2.6.0 + # via pygithub +pynacl==1.5.0 + # via pygithub +pyyaml==6.0 + # via + # myst-parser + # rocm-docs-core + # sphinx-external-toc +requests==2.31.0 + # via + # pygithub + # sphinx +rocm-docs-core==0.13.4 + # via -r requirements.in +smmap==5.0.0 + # via gitdb +snowballstemmer==2.2.0 + # via sphinx +soupsieve==2.4 + # via beautifulsoup4 +sphinx==5.3.0 + # via + # breathe + # myst-parser + # pydata-sphinx-theme + # rocm-docs-core + # sphinx-book-theme + # sphinx-copybutton + # sphinx-design + # sphinx-external-toc + # sphinx-notfound-page +sphinx-book-theme==1.0.1 + # via rocm-docs-core +sphinx-copybutton==0.5.1 + # via rocm-docs-core +sphinx-design==0.4.1 + # via rocm-docs-core +sphinx-external-toc==0.3.1 + # via rocm-docs-core +sphinx-notfound-page==0.8.3 + # via rocm-docs-core +sphinxcontrib-applehelp==1.0.4 + # via sphinx +sphinxcontrib-devhelp==1.0.2 + # via sphinx +sphinxcontrib-htmlhelp==2.0.1 + # via sphinx +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==1.0.3 + # via sphinx +sphinxcontrib-serializinghtml==1.1.5 + # via sphinx +typing-extensions==4.5.0 + # via pydata-sphinx-theme +uc-micro-py==1.0.1 + # via linkify-it-py +urllib3==1.26.15 + # via requests +wrapt==1.15.0 + # via deprecated diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..89de76b2 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,14 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +from rocm_docs import ROCmDocs + +docs_core = ROCmDocs("hipSPARSE Documentation") +docs_core.run_doxygen() +docs_core.setup() + +for sphinx_var in ROCmDocs.SPHINX_VARS: + globals()[sphinx_var] = getattr(docs_core, sphinx_var) diff --git a/docs/source/index.rst b/docs/index.rst similarity index 100% rename from docs/source/index.rst rename to docs/index.rst diff --git a/docs/rocm.jpg b/docs/rocm.jpg deleted file mode 100644 index 9bb8410072ff412f48b84b394b9a9d2f7229c6c8..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6761 zcmd^@c|28J+sC(%IU<>zWXwEN#;1=MiD0|WIA;tDjf4r zhKwge9Wxnnj`29d-p{`8&-2Iq{Pn(X@ALlgeBSk0|Lncj-fQjay4LUdt_%7KjR6k< z?%lh&c5`xbadGkRaP#u-6X56Lk8NjiZQ&>*t#BLFXOI!y7_vuEa zw!X2swN2ZhL!$sU8yf&10jdW3 z@xgHWQj1rJ$z}j^Q0vc+F zv|{9>B^m<2NNot1a7Qtn5tMurECd{Xf~9C`fvPx~LoN~mo}Wh2#Ka&#)QYLni-3SH zN(d%jA_OGlgZq4N5U?O32y(VUK&t};@anZgzy?n&1nioEfT^PY2TOQ~WDgH7w&}mz zFb|sk`O_smpVAd%+eH_M?8uo?U+iWNmbGsvpDHq?oLGsElN^eUsk;~8%h`D0g_(9f zdt~b!1f?oG7y`@Bc|+Mv#&Z?k6M@7p~Sr zKz%F?HaMS4J8DA@g(aIaRbXS6OcUr51mbEQxDVSjL?yBKN#yM>uwRgq*J(>&jNd9_ z0UQ0FIiK2a1SgHyBC9xLP*jz3KJ4q{yYorj^0SI@%8@9OZt#7(e_Ng4gby=4Neg`6 z3jr^({)kY;cAljQvM`7lHQb8?mA`kwO;$Dp%ot1w(%0=-+@ypv;0OEdq)VnCBoMHE#+*rz1OD5ElC!{@y*mF$^J~!>sjEH;|F| zwe$K!`aBX$xZX*74FQVgEy&Fc?BjCNe_h3kx{q4{5b&53hg|ALZpeEcGNk`Nem7Xa z{yloqs7~Oi*f{Lc0tCppW8g)Ea>2Vg_MNOw-=^PKozJqMS5nHd(_Hw=ZTbG1T{<4* zW_z{^v_*{N(QjT1BUe@3oXF~*8jDt^BdP@No9y+TMu?z%T|x<84^~IcUVIl-8|&Q0 zgZSP%>6r!r{5#L#eLfE_3%*Fq2PM`|zyS%HR8AQJ#N0_Oh^V`u0EMtMTktNxOStq# z68Bm2dmK8ep0*aDdlD&I&F5&oMd;!)KAj(`*6)toa3Wq4pEsU2O`mTk{Aod#>WFR# zSd*l3u|f*LhkmU}5a6NA_^mV-12Kmx`!1omBz=VE$$U?Sw>twd1FWRCaVRv${$pIa7ss@WkS%mISr1UaSleu}*h?PrXBPPvTsEYZ!U0B(ldiYc8 z1H*s1ert7v2%38yfB=F%Y~&>LOY+i72tbqanEY_0y?q4%Bx6`aozC00+V7~!%E1Hk znbCn84t9G!X^TfL`?9}TXo)b`;93S-Yvrc8TkszTAzhJzGW_u$=V5Rp$0Upm^XQf*A34P``?tW;y&#wvTN*#7K$bs9Ki;VzZBxWu`N?#c$Pv)tXyStLpOO~lA_zXQ#8iwuZ>$vh_?s0 zP7|xEaCBZWcETJ2l63u1jy2JF__H4~4l_E|^$yV=_|H?~7*Xa;tPi^*w-ajwlAWwa4cF(8=1wo)TlF4)Tn5-L~mpiB~4Ax*(`hZL;hn<}uE~Xy#E?c4)Pl z{3rDnu{zPexu~?{o}#W?q_4);BEl%7GkqH?A|0fOwferWE$g(dQSN|eGVRJT7WY6n zQKotJ)j!6|NRDb>F*DXt1uOoWozwZ(X;lgL{u5*;pnw*a|6{m%{Q@LWF<5%u(P0qRn%GVNP z*X-;oTymKwsEB5aOS9Qn(+B0Rn}}m>-3%4n3@~#=WYMUc(27{|qZ{@MviOI^qL|JU zf<2`yx}5kNQ+O^(++OSJ(6&qqF584+;ST{#0Tg>M8p|vsz~pzDD%KjnE*Lvn7+Y&l z=suQR^i)3X_`yf}<<;#l#@hwqGL+Tm@(AgrBOoz>VOL%`BA7-|odC{GnK(*=cKx$FbYYUr@EZjz(0LMF%w7V<&`$u-EW z%`Cl7lR07+ zzUXgMFiwsMX1EEa!#t9aFc?BTCEC!feKi zg0rqz%8ObU?v8&&QZ$iNn5kWGFjGr$ft>B2!P`QnKCSxIHPR6a+)sT*85sP*)1qoy zbGY|dL+h<0+Yf@t0!ta8riC|BJikR>bMQXTFOiUZqG3idAfZ;K41IXYgJ}t#^J=FjNR9DEfH8fo9hlsw;bO4*8N%HscwlH*+;~kSy?u7A%tk0ZipX z^G_bJ=$4EGX%$p8&4OgWM;NY3~_}7o9Q}gAGVVKW6&1NKjsDz z0s#(`?dA5uMOWtmH&4rb3dPSK3p8>);9fWrV$ak>{CQw$H)QR=2bOp^%|^FQ!@(my z2LVJKEESG{ns6-q9cl9RoEE6`CKxB?m$g;qUwr-EYGBy)eddQOIL+Q(Y5;|z!Ft@9XnWt^DfyRq@87`dqGfqBA6Kfz*LQuDKUNhM z!mD;%SaV2KP{G9tO9^Wa^?#OmXW?|8B_A@~#8I1_m44ZNLJiTJyPJwgyp-!9c*ZcE zo%8p2hr_A5rt5;I@Gi7FQ!L)`@#~TT@XK4xQf9O2sghVrhe_*&*@cTSpZ z;a3P~?`j+j3HQk}HVNhJJn1XrV0keaC<_pxxm~2ZnmM2KEu}K|0<*Q1VbKWvYHx0zPV*w_&PZtKo0V zz5i4A;Qq^4>6|F#Qb(+=jEhuQQ@6#RH$wE(jZN9d!RYhSHg>I?xHNeV>`ILnS79uUy@zMzWcGd&h}1zj#z zeJ}Z>;zeT?co-!8s?i>nH)SjdcMg!xQthtx;jYhoyvP;Z1roqj(zuxuK%#G0|X zt45m;Y^%W~5QR5~sLsQ&FUV(J{TTJbJaz2u@*Y7eq&Kpg07eblW!Q%iI(5`XB#@ta zj!-=E-R-EA;^%-MwMUO~?YR!*o^VK*(?>;BXN}7$tQjcSmhGpmaA=5+>7b^*U+|Zq z%c^eWP{OQ9{x>x?kWxRk=|dlGhFMP^)NL+u(MWwieM|gD|9dP?xZzN^eKC3TQ)j{G zkC#bii}OFnrj5maj?3zDNvF6OV)-^cvvxy(69t=akR)aI*~3lhYIM_m8}H7Y523%U zN2Mg_;~v_Vpn02HQDeiyZ|qj)%UZ&OxratW857Q{fmdKa$grO`=MomwYtW9vLhF!RB(gfOQ2)cHqXY1|5 zl64ZtGr=N>?eerq8N$|lQ?Jyuck{tB9j-==v+<9jnInOoPI>4sr@>l#pI7Eyw{B(y zTj4$*O-o5_mS!7F>#tjF^;93I#E(ju>2`_>vgC8UHqF+t z&m_2rY~wF~VNs;2ORqS!FtF1xOvq+};bKlvYp%|49U>)GiFX&IdHEd>ImH{Rz(0NL zxW@?c)ELEklN<*k!flCfZ1zuqb0PUj5nB>GqsJ)LGY3wWIrh{&iE-i|^ zpVVg#V8?in4KDExzlu}k%}q#=aQlfCA>Zmm#atVP;-}R_Gd*ID3u37iosOcP3^9Lou%Mr}8vFk;SGo7+?jgEy}Cb!z&Ck#_olWH_46HP{EOV$@-Dl5{VYCsm%nt6>HAW$Shxcf znIw1kL-gRS5n-Onsxv96drlZD$>hXCn$F+VieUF6rfkx3D zGBc2hnR~poH=EDu_XzsWVSzN8HXdb#U6|us1EQTYr#4q|lz~V{zDI~fgK*1q(Cx^P zOnS1Voj?$s)P@pTlJuT^boYp5Zgo-LHyfYp&U5EEv=yIha^O&*^FK`jOWbL)q$XWH z?DA({{**~%NKV)IJB<5Qelut|RBMp8IBIdfnxR=Dkv!e?sN%QRPEol=Uhdt$xPkv! zXHv84ZILX;zxw8zk-2W}bq@j%LTZ<;OiL$kKK(06|6(oX-;kUCd$lyJ$QG?ujCLxp zHa`RNp%URF72EJ}RhU-cIDCmznwR_&rQ?PEnm)lVELe3J+ibXq-O#;&B^N+|Byuu) z6G@j)N3ITFlMs|{I-bR!f!O{*Y{Sv6vh2YaTS3MKdD@Dp7f}dfpkgeG9so1A1knk` zxYTBlWk`byD*R-)fcK^I5(GqKGp|8FOaNSPS-A2BhR8FZ{(t0*+QAb=du tgVTX)(BvFhFSsyGJYv!gG9rRPaI7un!a9Pn@_+IM>CZX(Z>vEg{{TQi^8^3@ diff --git a/docs/run_doc.sh b/docs/run_doc.sh deleted file mode 100755 index f87b2325..00000000 --- a/docs/run_doc.sh +++ /dev/null @@ -1,22 +0,0 @@ -#!/bin/bash - -set -eu - -# Make this directory the PWD -cd "$(dirname "${BASH_SOURCE[0]}")" - -# Update version string -cur_version=$(sed -n -e "s/^.*VERSION_STRING.* \"\([0-9\.]\{1,\}\).*/\1/p" ../CMakeLists.txt) -sed -i -e "s/\(PROJECT_NUMBER.*=\)\(.*\)/\1 v${cur_version}/" Doxyfile -sed -i -e "s/\(version.*=\)\(.*\)/\1 u'${cur_version}'/" source/conf.py -sed -i -e "s/\(release.*=\)\(.*\)/\1 u'${cur_version}'/" source/conf.py - -# Build doxygen info -rm -rf docBin -doxygen Doxyfile - -# Build sphinx docs -cd source -make clean -make html -make latexpdf diff --git a/docs/run_doxygen.sh b/docs/run_doxygen.sh deleted file mode 100755 index dedfdb0e..00000000 --- a/docs/run_doxygen.sh +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/bash - -set -eu - -# Make this directory the PWD -cd "$(dirname "${BASH_SOURCE[0]}")" - -# Update version string -cur_version=$(sed -n -e "s/^.*VERSION_STRING.* \"\([0-9\.]\{1,\}\).*/\1/p" ../CMakeLists.txt) -sed -i -e "s/\(PROJECT_NUMBER.*=\)\(.*\)/\1 v${cur_version}/" Doxyfile - -# Build the doxygen info -rm -rf docBin -doxygen Doxyfile diff --git a/docs/source/Makefile b/docs/source/Makefile deleted file mode 100644 index a0e8b475..00000000 --- a/docs/source/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SPHINXPROJ = hipSPARSE -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/source/_static/theme_overrides.css b/docs/source/_static/theme_overrides.css deleted file mode 100644 index 63ee6cc7..00000000 --- a/docs/source/_static/theme_overrides.css +++ /dev/null @@ -1,13 +0,0 @@ -/* override table width restrictions */ -@media screen and (min-width: 767px) { - - .wy-table-responsive table td { - /* !important prevents the common CSS stylesheets from overriding - this as on RTD they are loaded after this stylesheet */ - white-space: normal !important; - } - - .wy-table-responsive { - overflow: visible !important; - } -} diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index dcc25aea..00000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,191 +0,0 @@ -# -*- coding: utf-8 -*- -# -# hipSPARSE documentation build configuration file, created by -# sphinx-quickstart on Mon Sep 3 11:16:32 2018. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - -import os -import sys -import subprocess - -read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' - -if read_the_docs_build: - subprocess.call('../run_doxygen.sh') - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ['sphinx.ext.mathjax', 'breathe'] -breathe_projects = { "hipSPARSE": "../docBin/xml" } -breathe_default_project = "hipSPARSE" - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'hipSPARSE' -copyright = u'2021, Advanced Micro Devices' -author = u'Advanced Micro Devices' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = u'' -# The full version, including alpha/beta/rc tags. -release = u'' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -# html_theme = 'alabaster' - -if read_the_docs_build: - html_theme = 'default' -else: - import sphinx_rtd_theme - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -html_context = { - 'css_files': [ - '_static/theme_overrides.css', # override wide tables in RTD theme - ], - } - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -# html_sidebars = { -# '**': [ -# 'relations.html', # needs 'show_related': True theme option to display -# 'searchbox.html', -# ] -# } - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = 'hipSPARSEdoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - 'preamble': '\\usepackage[strings]{underscore}', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'hipSPARSE.tex', u'hipSPARSE Documentation', - u'Advanced Micro Devices', 'manual'), -] - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'hipsparse', u'hipSPARSE Documentation', - [author], 1) -] - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'hipSPARSE Documentation', u'hipSPARSE Documentation', - author, 'hipSPARSE Documentation', 'Sparse Linear Algebra Subroutines', - 'Miscellaneous'), -] - - - diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt deleted file mode 100644 index ce978c40..00000000 --- a/docs/source/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ - -breathe - diff --git a/docs/source/usermanual.rst b/docs/usermanual.rst similarity index 100% rename from docs/source/usermanual.rst rename to docs/usermanual.rst