Skip to content

Commit

Permalink
Update Documentation (#173)
Browse files Browse the repository at this point in the history
  • Loading branch information
rusty1s authored Jan 10, 2023
1 parent b78a67e commit ef340dd
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 7 deletions.
12 changes: 12 additions & 0 deletions docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/* Monospace font in "Package Reference" navigation */
.wy-menu-vertical > ul:nth-child(2) li.toctree-l1 > a {
font-family: SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;
}

/* Monospace font in "Package Reference" titles */
#module-pyg_lib h1,
#module-pyg_lib\.ops h1,
#module-pyg_lib\.sampler h1 {
font-family: SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;
letter-spacing: -1px;
}
9 changes: 9 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import datetime
import os.path as osp
import sys

import pyg_sphinx_theme

import pyg_lib

Expand All @@ -7,19 +11,24 @@
version = pyg_lib.__version__
copyright = f'{datetime.datetime.now().year}, {author}'

sys.path.append(osp.join(osp.dirname(pyg_sphinx_theme.__file__), 'extension'))

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
'pyg',
]

html_theme = 'pyg_sphinx_theme'
html_logo = ('https://raw.githubusercontent.com/pyg-team/pyg_sphinx_theme/'
'master/pyg_sphinx_theme/static/img/pyg_logo.png')
html_favicon = ('https://raw.githubusercontent.com/pyg-team/pyg_sphinx_theme/'
'master/pyg_sphinx_theme/static/img/favicon.png')
html_static_path = ['_static']
html_css_files = ['css/custom.css']

add_module_names = False
autodoc_member_order = 'bysource'
Expand Down
10 changes: 3 additions & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
:github_url: https://github.com/pyg-team/pyg-lib

pyg_lib Documentation
PyG-lib Documentation
=====================

.. slack::

.. toctree::
:maxdepth: 1
:caption: Package Reference

modules/root
modules/ops
modules/sampler

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`

0 comments on commit ef340dd

Please sign in to comment.