Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 9142098

Browse files
qibincqibinc
committed
Add docs and CI
1 parent 98976ad commit 9142098

6 files changed

Lines changed: 272 additions & 0 deletions

File tree

‎.readthedocs.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Required
2+
version: 2
3+
4+
# Build documentation in the docs/ directory with Sphinx
5+
sphinx:
6+
configuration: docs/source/conf.py
7+
8+
# Optionally build your docs in additional formats such as PDF and ePub
9+
formats: all
10+
11+
# Optionally set the version of Python and requirements required to build your docs
12+
python:
13+
version: 3.6
14+
install:
15+
- requirements: requirements.txt

‎.travis.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
language: python
2+
3+
python:
4+
- "3.7"
5+
- "3.6"
6+
7+
install:
8+
- pip install torch torchvision
9+
- pip install -r requirements.txt
10+
- pip install coveralls
11+
12+
after_success:
13+
- coverage combine
14+
- coveralls
15+
16+
notifications:
17+
email: false

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# CogDL
22

3+
[![Build Status](https://travis-ci.org/THUDM/cogdl.svg?branch=master)](https://travis-ci.org/THUDM/cogdl)
4+
[![Maintainability](https://api.codeclimate.com/v1/badges/d587092245542684c80b/maintainability)](https://codeclimate.com/github/THUDM/cogdl/maintainability)
5+
[![Coverage Status](https://coveralls.io/repos/github/THUDM/cogdl/badge.svg?branch=master)](https://coveralls.io/github/THUDM/cogdl?branch=master)
6+
[![Documentation Status](https://readthedocs.org/projects/cogdl/badge/?version=latest)](https://cogdl.readthedocs.io/en/latest/?badge=latest)
7+
![License](https://img.shields.io/github/license/thudm/cogdl)
8+
39
CogDL is a graph representation learning toolkit that allows researchers and developers to easily train and compare baseline or custom models for node classification, link prediction and other tasks on graphs. It provides implementations of many popular models, including: non-GNN Baselines like Deepwalk, LINE, NetMF, GNN Baselines like GCN, GAT, GraphSAGE.
410

511
Note that CogDL is **still actively under development**, so feedback and contributions are welcome.

‎docs/Makefile‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SOURCEDIR = source
8+
BUILDDIR = build
9+
10+
# Put it first so that "make" without argument is like "make help".
11+
help:
12+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13+
14+
.PHONY: help Makefile
15+
16+
# Catch-all target: route all unknown targets to Sphinx using the new
17+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18+
%: Makefile
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/source/conf.py‎

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Configuration file for the Sphinx documentation builder.
4+
#
5+
# This file does only contain a selection of the most common options. For a
6+
# full list see the documentation:
7+
# http://www.sphinx-doc.org/en/master/config
8+
9+
# -- Path setup --------------------------------------------------------------
10+
11+
# If extensions (or modules to document with autodoc) are in another directory,
12+
# add these directories to sys.path here. If the directory is relative to the
13+
# documentation root, use os.path.abspath to make it absolute, like shown here.
14+
#
15+
# import os
16+
# import sys
17+
# sys.path.insert(0, os.path.abspath('.'))
18+
19+
20+
# -- Project information -----------------------------------------------------
21+
22+
project = 'CogDL'
23+
copyright = '2019, KEG'
24+
author = 'KEG'
25+
26+
# The short X.Y version
27+
version = ''
28+
# The full version, including alpha/beta/rc tags
29+
release = ''
30+
31+
32+
# -- General configuration ---------------------------------------------------
33+
34+
# If your documentation needs a minimal Sphinx version, state it here.
35+
#
36+
# needs_sphinx = '1.0'
37+
38+
# Add any Sphinx extension module names here, as strings. They can be
39+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40+
# ones.
41+
extensions = [
42+
'sphinx.ext.autodoc',
43+
'sphinx.ext.doctest',
44+
'sphinx.ext.intersphinx',
45+
'sphinx.ext.todo',
46+
'sphinx.ext.coverage',
47+
'sphinx.ext.mathjax',
48+
'sphinx.ext.ifconfig',
49+
'sphinx.ext.viewcode',
50+
'recommonmark',
51+
]
52+
53+
# Add any paths that contain templates here, relative to this directory.
54+
templates_path = ['_templates']
55+
56+
# The suffix(es) of source filenames.
57+
# You can specify multiple suffix as a list of string:
58+
#
59+
# source_suffix = ['.rst', '.md']
60+
source_suffix = '.md'
61+
62+
# The master toctree document.
63+
master_doc = 'index'
64+
65+
# The language for content autogenerated by Sphinx. Refer to documentation
66+
# for a list of supported languages.
67+
#
68+
# This is also used if you do content translation via gettext catalogs.
69+
# Usually you set "language" from the command line for these cases.
70+
language = None
71+
72+
# List of patterns, relative to source directory, that match files and
73+
# directories to ignore when looking for source files.
74+
# This pattern also affects html_static_path and html_extra_path.
75+
exclude_patterns = []
76+
77+
# The name of the Pygments (syntax highlighting) style to use.
78+
pygments_style = None
79+
80+
81+
# -- Options for HTML output -------------------------------------------------
82+
83+
# The theme to use for HTML and HTML Help pages. See the documentation for
84+
# a list of builtin themes.
85+
#
86+
html_theme = 'alabaster'
87+
88+
# Theme options are theme-specific and customize the look and feel of a theme
89+
# further. For a list of options available for each theme, see the
90+
# documentation.
91+
#
92+
# html_theme_options = {}
93+
94+
# Add any paths that contain custom static files (such as style sheets) here,
95+
# relative to this directory. They are copied after the builtin static files,
96+
# so a file named "default.css" will overwrite the builtin "default.css".
97+
html_static_path = ['_static']
98+
99+
# Custom sidebar templates, must be a dictionary that maps document names
100+
# to template names.
101+
#
102+
# The default sidebars (for documents that don't match any pattern) are
103+
# defined by theme itself. Builtin themes are using these templates by
104+
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
105+
# 'searchbox.html']``.
106+
#
107+
# html_sidebars = {}
108+
109+
110+
# -- Options for HTMLHelp output ---------------------------------------------
111+
112+
# Output file base name for HTML help builder.
113+
htmlhelp_basename = 'CogDLdoc'
114+
115+
116+
# -- Options for LaTeX output ------------------------------------------------
117+
118+
latex_elements = {
119+
# The paper size ('letterpaper' or 'a4paper').
120+
#
121+
# 'papersize': 'letterpaper',
122+
123+
# The font size ('10pt', '11pt' or '12pt').
124+
#
125+
# 'pointsize': '10pt',
126+
127+
# Additional stuff for the LaTeX preamble.
128+
#
129+
# 'preamble': '',
130+
131+
# Latex figure (float) alignment
132+
#
133+
# 'figure_align': 'htbp',
134+
}
135+
136+
# Grouping the document tree into LaTeX files. List of tuples
137+
# (source start file, target name, title,
138+
# author, documentclass [howto, manual, or own class]).
139+
latex_documents = [
140+
(master_doc, 'CogDL.tex', 'CogDL Documentation',
141+
'KEG', 'manual'),
142+
]
143+
144+
145+
# -- Options for manual page output ------------------------------------------
146+
147+
# One entry per manual page. List of tuples
148+
# (source start file, name, description, authors, manual section).
149+
man_pages = [
150+
(master_doc, 'cogdl', 'CogDL Documentation',
151+
[author], 1)
152+
]
153+
154+
155+
# -- Options for Texinfo output ----------------------------------------------
156+
157+
# Grouping the document tree into Texinfo files. List of tuples
158+
# (source start file, target name, title, author,
159+
# dir menu entry, description, category)
160+
texinfo_documents = [
161+
(master_doc, 'CogDL', 'CogDL Documentation',
162+
author, 'CogDL', 'One line description of project.',
163+
'Miscellaneous'),
164+
]
165+
166+
167+
# -- Options for Epub output -------------------------------------------------
168+
169+
# Bibliographic Dublin Core info.
170+
epub_title = project
171+
172+
# The unique identifier of the text. This can be a ISBN number
173+
# or the project homepage.
174+
#
175+
# epub_identifier = ''
176+
177+
# A unique identification for the text.
178+
#
179+
# epub_uid = ''
180+
181+
# A list of files that should not be packed into the epub file.
182+
epub_exclude_files = ['search.html']
183+
184+
185+
# -- Extension configuration -------------------------------------------------
186+
187+
# -- Options for intersphinx extension ---------------------------------------
188+
189+
# Example configuration for intersphinx: refer to the Python standard library.
190+
intersphinx_mapping = {'https://docs.python.org/': None}
191+
192+
# -- Options for todo extension ----------------------------------------------
193+
194+
# If true, `todo` and `todoList` produce output, else they produce nothing.
195+
todo_include_todos = True

‎docs/source/index.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. CogDL documentation master file, created by
2+
sphinx-quickstart on Thu Dec 19 20:17:06 2019.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to CogDL's documentation!
7+
=================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`

0 commit comments

Comments
 (0)