Update requirements.txt (#574)

* update requirements

remove unused .gitignore

* fix typo in functions docs page

* brain float 16

* remove disclaimer

.gitignore

@@ -40,8 +40,10 @@ build*
 *~
 
 # documentation artifacts
+build/
 _build/
 _images/
 _static/
 _templates/
 _toc.yml
+docBin/

README.md

@@ -10,11 +10,15 @@ hipBLAS requires either **rocBLAS** + **rocSOLVER** or **cuBLAS** APIs for BLAS
 
 ### How to build 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
+```
 
 ## Quickstart build
 

docs/.sphinx/_toc.yml.in

@@ -10,4 +10,4 @@ subtrees:
     - file: api
     - file: functions
     - file: deprecation
-    - file: contributing
+    - file: contributing

docs/.sphinx/requirements.in

@@ -1 +1 @@
-git+https://github.com/RadeonOpenCompute/rocm-docs-core.git
+git+https://github.com/RadeonOpenCompute/rocm-docs-core.git

docs/.sphinx/requirements.txt

@@ -2,39 +2,41 @@
 # This file is autogenerated by pip-compile with Python 3.8
 # by the following command:
 #
-#    pip-compile docs/sphinx/requirements.in
+#    pip-compile requirements.in
 #
 accessible-pygments==0.0.3
     # via pydata-sphinx-theme
-alabaster==0.7.12
+alabaster==0.7.13
     # via sphinx
-asttokens==2.2.0
+asttokens==2.2.1
     # via stack-data
-attrs==22.1.0
+attrs==22.2.0
     # via
     #   jsonschema
     #   jupyter-cache
-babel==2.10.3
+babel==2.12.1
     # via
     #   pydata-sphinx-theme
     #   sphinx
 backcall==0.2.0
     # via ipython
-beautifulsoup4==4.11.1
+beautifulsoup4==4.11.2
     # via pydata-sphinx-theme
 breathe==4.34.0
     # via rocm-docs-core
-certifi==2022.6.15
+certifi==2022.12.7
     # via requests
 cffi==1.15.1
     # via pynacl
-charset-normalizer==2.1.0
+charset-normalizer==3.1.0
     # via requests
 click==8.1.3
     # via
     #   jupyter-cache
     #   sphinx-external-toc
-debugpy==1.6.4
+comm==0.1.2
+    # via ipykernel
+debugpy==1.6.6
     # via ipykernel
 decorator==5.1.1
     # via ipython
@@ -47,33 +49,32 @@ docutils==0.16
     #   pydata-sphinx-theme
     #   rocm-docs-core
     #   sphinx
-entrypoints==0.4
-    # via jupyter-client
 executing==1.2.0
     # via stack-data
-fastjsonschema==2.16.2
+fastjsonschema==2.16.3
     # via nbformat
 gitdb==4.0.10
     # via gitpython
 gitpython==3.1.31
     # via rocm-docs-core
-greenlet==2.0.1
+greenlet==2.0.2
     # via sqlalchemy
-idna==3.3
+idna==3.4
     # via requests
 imagesize==1.4.1
     # via sphinx
-importlib-metadata==5.1.0
+importlib-metadata==6.0.0
     # via
     #   jupyter-cache
+    #   jupyter-client
     #   myst-nb
 importlib-resources==5.10.4
     # via
     #   jsonschema
     #   rocm-docs-core
-ipykernel==6.17.1
+ipykernel==6.21.3
     # via myst-nb
-ipython==8.7.0
+ipython==8.11.0
     # via
     #   ipykernel
     #   myst-nb
@@ -87,27 +88,28 @@ jsonschema==4.17.3
     # via nbformat
 jupyter-cache==0.5.0
     # via myst-nb
-jupyter-client==7.4.7
+jupyter-client==8.0.3
     # via
     #   ipykernel
     #   nbclient
-jupyter-core==5.1.0
+jupyter-core==5.3.0
     # via
+    #   ipykernel
     #   jupyter-client
     #   nbformat
 linkify-it-py==1.0.3
     # via myst-parser
-markdown-it-py==2.1.0
+markdown-it-py==2.2.0
     # via
     #   mdit-py-plugins
     #   myst-parser
-markupsafe==2.1.1
+markupsafe==2.1.2
     # via jinja2
 matplotlib-inline==0.1.6
     # via
     #   ipykernel
     #   ipython
-mdit-py-plugins==0.3.1
+mdit-py-plugins==0.3.5
     # via myst-parser
 mdurl==0.1.2
     # via markdown-it-py
@@ -121,17 +123,16 @@ nbclient==0.5.13
     # via
     #   jupyter-cache
     #   myst-nb
-nbformat==5.7.0
+nbformat==5.7.3
     # via
     #   jupyter-cache
     #   myst-nb
     #   nbclient
 nest-asyncio==1.5.6
     # via
     #   ipykernel
-    #   jupyter-client
     #   nbclient
-packaging==21.3
+packaging==23.0
     # via
     #   ipykernel
     #   pydata-sphinx-theme
@@ -144,9 +145,9 @@ pickleshare==0.7.5
     # via ipython
 pkgutil-resolve-name==1.3.10
     # via jsonschema
-platformdirs==2.5.4
+platformdirs==3.1.1
     # via jupyter-core
-prompt-toolkit==3.0.33
+prompt-toolkit==3.0.38
     # via ipython
 psutil==5.9.4
     # via ipykernel
@@ -160,7 +161,7 @@ pydata-sphinx-theme==0.13.1
     # via sphinx-book-theme
 pygithub==1.57
     # via rocm-docs-core
-pygments==2.12.0
+pygments==2.14.0
     # via
     #   accessible-pygments
     #   ipython
@@ -170,30 +171,28 @@ pyjwt==2.6.0
     # via pygithub
 pynacl==1.5.0
     # via pygithub
-pyparsing==3.0.9
-    # via packaging
-pyrsistent==0.19.2
+pyrsistent==0.19.3
     # via jsonschema
 python-dateutil==2.8.2
     # via jupyter-client
-pytz==2022.1
+pytz==2022.7.1
     # via babel
 pyyaml==6.0
     # via
     #   jupyter-cache
     #   myst-nb
     #   myst-parser
     #   sphinx-external-toc
-pyzmq==24.0.1
+pyzmq==25.0.1
     # via
     #   ipykernel
     #   jupyter-client
-requests==2.28.1
+requests==2.28.2
     # via
     #   pygithub
     #   sphinx
 rocm-docs-core @ git+https://github.com/RadeonOpenCompute/rocm-docs-core.git
-    # via -r docs/sphinx/requirements.in
+    # via -r requirements.in
 six==1.16.0
     # via
     #   asttokens
@@ -202,7 +201,7 @@ smmap==5.0.0
     # via gitdb
 snowballstemmer==2.2.0
     # via sphinx
-soupsieve==2.3.2.post1
+soupsieve==2.4
     # via beautifulsoup4
 sphinx==4.3.1
     # via
@@ -215,6 +214,7 @@ sphinx==4.3.1
     #   sphinx-copybutton
     #   sphinx-design
     #   sphinx-external-toc
+    #   sphinx-notfound-page
 sphinx-book-theme==1.0.0rc2
     # via rocm-docs-core
 sphinx-copybutton==0.5.1
@@ -223,19 +223,21 @@ sphinx-design==0.3.0
     # via rocm-docs-core
 sphinx-external-toc==0.3.1
     # via rocm-docs-core
-sphinxcontrib-applehelp==1.0.2
+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.0
+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
-sqlalchemy==1.4.44
+sqlalchemy==1.4.46
     # via jupyter-cache
 stack-data==0.6.2
     # via ipython
@@ -245,28 +247,29 @@ tornado==6.2
     # via
     #   ipykernel
     #   jupyter-client
-traitlets==5.6.0
+traitlets==5.9.0
     # via
+    #   comm
     #   ipykernel
     #   ipython
     #   jupyter-client
     #   jupyter-core
     #   matplotlib-inline
     #   nbclient
     #   nbformat
-typing-extensions==4.4.0
+typing-extensions==4.5.0
     # via
     #   myst-nb
     #   myst-parser
 uc-micro-py==1.0.1
     # via linkify-it-py
-urllib3==1.26.11
+urllib3==1.26.15
     # via requests
-wcwidth==0.2.5
+wcwidth==0.2.6
     # via prompt-toolkit
 wrapt==1.15.0
     # via deprecated
-zipp==3.11.0
+zipp==3.15.0
     # via
     #   importlib-metadata
     #   importlib-resources

docs/designdoc.rst

@@ -8,5 +8,4 @@ Design Documentation
    :maxdepth: 3
    :caption: Contents:
 
-   disclaimer
    clients

docs/functions.rst

@@ -20,7 +20,7 @@ Notations
 hipBLAS function uses the following notations to denote precisions,
 
 - h  = half
-- bf = 16 bit brian floating point
+- bf = 16 bit brain floating point
 - s  = single
 - d  = double
 - c  = single complex

docs/usermanual.rst

@@ -8,7 +8,6 @@ User Guide
    :maxdepth: 3
    :caption: Contents:
 
-   disclaimer
    intro
    install
    deprecation