Commit 0096203d authored by narugo1992's avatar narugo1992
Browse files

dev(narugo): update documentation

parent 73ca3fad

.github/workflows/doc.yml

+1 −1
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ jobs: 
      - name: Install dependencies

        run: |

          sudo apt-get update -y

          sudo apt-get install -y make wget curl cloc graphviz

          sudo apt-get install -y make wget curl cloc graphviz pandoc

          dot -V

          python -m pip install -r requirements.txt

          python -m pip install -r requirements-doc.txt

docs/source/all.mk

+4 −0
Original line number Diff line number Diff line
@@ -12,6 +12,8 @@ GRAPHVIZ_MK := ${SOURCEDIR}/graphviz.mk 
GRAPHVIZ    := $(MAKE) -f "${GRAPHVIZ_MK}" SOURCE=${SOURCEDIR}

DEMOS_MK    := ${SOURCEDIR}/demos.mk

DEMOS       := $(MAKE) -f "${DEMOS_MK}" SOURCE=${SOURCEDIR}

NOTEBOOK_MK := ${SOURCEDIR}/notebook.mk

NOTEBOOK    := $(MAKE) -f "${NOTEBOOK_MK}" SOURCE=${SOURCEDIR}



_CURRENT_PATH := ${PATH}

_PROJ_DIR     := $(shell readlink -f ${SOURCEDIR}/../..)
@@ -33,6 +35,7 @@ build: 
	@$(DIAGRAMS) build

	@$(GRAPHVIZ) build

	@$(DEMOS) build

	@$(NOTEBOOK) build



all: build
@@ -40,4 +43,5 @@ clean: 
	@$(DIAGRAMS) clean

	@$(GRAPHVIZ) clean

	@$(DEMOS) clean

	@$(NOTEBOOK) clean

docs/source/conf.py

+1 −0
Original line number Diff line number Diff line
@@ -109,6 +109,7 @@ extensions = [ 
    'sphinx.ext.graphviz',

    'enum_tools.autoenum',

    "sphinx_multiversion",

    'nbsphinx',

]



# Add any paths that contain templates here, relative to this directory.

docs/source/index.rst

+5 −0
Original line number Diff line number Diff line
@@ -18,6 +18,11 @@ configuration file's structure and their versions. 
    :maxdepth: 2

    :caption: Best Practice



.. toctree::

    :maxdepth: 2

    :caption: Information



    information/environment.result



.. toctree::

    :maxdepth: 2

docs/source/information/environment.ipynb

0 → 100644
+31 −0
Original line number Diff line number Diff line 
%% Cell type:markdown id: tags:



# Run Environment Information



%% Cell type:markdown id: tags:



Here is the information from the running environment.



%% Cell type:code id: tags:



``` python

import os

import platform

import shutil



import cpuinfo

import psutil

from hbutils.scale import size_to_bytes_str



print('OS:', platform.platform())

print('Python:', platform.python_implementation(), platform.python_version())

print('CPU Brand:', cpuinfo.get_cpu_info()["brand_raw"])

print('CPU Count:', os.cpu_count())

print('CPU Freq:', psutil.cpu_freq().current, 'MHz')

print('Memory Size:', size_to_bytes_str(psutil.virtual_memory().total, precision=3))

print('Has CUDA:', 'Yes' if shutil.which('nvidia-smi') else 'No')

```



%% Cell type:markdown id: tags:



Please note that, this information in deployed documentation is automatically executed on Github Action. Therefore, some performance data may be different with your local environment