Skip to content

Commit 736f757

Browse files
AyanSinhaMahapatraAyanSinhaMahapatra
authored
Merge pull request #107 from nexB/add-skeleton
Add skeleton to aboutcode docs
2 parents 17cbc15 + 757edd5 commit 736f757

34 files changed

Lines changed: 1013 additions & 243 deletions

‎.gitattributes‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Ignore all Git auto CR/LF line endings conversions
2+
* -text
3+
pyproject.toml export-subst

‎.github/workflows/docs-ci.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CI Documentation
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-20.04
8+
9+
strategy:
10+
max-parallel: 4
11+
matrix:
12+
python-version: [3.7]
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v2
17+
18+
- name: Set up Python ${{ matrix.python-version }}
19+
uses: actions/setup-python@v2
20+
with:
21+
python-version: ${{ matrix.python-version }}
22+
23+
- name: Give permission to run scripts
24+
run: chmod +x ./docs/scripts/doc8_style_check.sh
25+
26+
- name: Install Dependencies
27+
run: pip install -e .[docs]
28+
29+
- name: Check Sphinx Documentation build minimally
30+
working-directory: ./docs
31+
run: sphinx-build -E -W source build
32+
33+
- name: Check for documentation style errors
34+
working-directory: ./docs
35+
run: ./scripts/doc8_style_check.sh
36+
37+

‎.gitignore‎

Lines changed: 64 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,73 @@
1-
*.pyc
2-
*.db
3-
.installed.cfg
4-
parts
5-
develop-eggs
6-
bin
7-
eggs
8-
downloads
9-
lib
10-
lib64
11-
build
12-
.project
13-
.pydevproject
14-
include
15-
.settings
16-
TAGS
17-
.idea
18-
Include
19-
Lib
20-
.env
21-
Procfile
22-
tmp
23-
.Python
24-
local.cfg
25-
_build
26-
pip-selfcheck.json
27-
pyvenv.cfg
28-
geckodriver.log
29-
.DS_Store
1+
# Python compiled files
2+
*.py[cod]
303

314
# virtualenv and other misc bits
32-
.venv/
5+
*.egg-info
6+
/dist
337
/build
34-
build/
8+
/bin
9+
/lib
10+
/scripts
11+
/Scripts
12+
/Lib
13+
/pip-selfcheck.json
14+
/tmp
15+
/venv
16+
.Python
17+
/include
18+
/Include
19+
/local
20+
*/local/*
21+
/local/
22+
/share/
23+
/tcl/
24+
/.eggs/
25+
26+
# Installer logs
27+
pip-log.txt
28+
29+
# Unit test / coverage reports
30+
.cache
31+
.coverage
32+
.coverage.*
33+
nosetests.xml
34+
htmlcov
35+
36+
# Translations
37+
*.mo
3538

3639
# IDEs
40+
.project
41+
.pydevproject
42+
.idea
43+
org.eclipse.core.resources.prefs
3744
.vscode
45+
.vs
3846

3947
# Sphinx
4048
docs/_build
49+
docs/bin
50+
docs/build
51+
docs/include
52+
docs/Lib
53+
doc/pyvenv.cfg
54+
pyvenv.cfg
55+
56+
# Various junk and temp files
57+
.DS_Store
58+
*~
59+
.*.sw[po]
60+
.build
61+
.ve
62+
*.bak
63+
/.cache/
64+
65+
# pyenv
66+
/.python-version
67+
/man/
68+
/.pytest_cache/
69+
lib64
70+
tcl
71+
72+
# Ignore Jupyter Notebook related temp files
73+
.ipynb_checkpoints/

‎.readthedocs.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Where the Sphinx conf.py file is located
9+
sphinx:
10+
configuration: docs/source/conf.py
11+
12+
# Setting the python version and doc build requirements
13+
python:
14+
install:
15+
- method: pip
16+
path: .
17+
extra_requirements:
18+
- docs

‎.travis.yml‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎MANIFEST.in‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
graft src
2+
3+
include *.LICENSE
4+
include NOTICE
5+
include *.ABOUT
6+
include *.toml
7+
include *.yml
8+
include *.rst
9+
include setup.*
10+
include configure*
11+
include requirements*
12+
include .git*
13+
14+
global-exclude *.py[co] __pycache__ *.*~
15+

‎NOTICE‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#
2+
# Copyright (c) nexB Inc. and others.
3+
# SPDX-License-Identifier: Apache-2.0
4+
#
5+
# Visit https://aboutcode.org and https://github.com/nexB/ for support and download.
6+
# ScanCode is a trademark of nexB Inc.
7+
#
8+
# Licensed under the Apache License, Version 2.0 (the "License");
9+
# you may not use this file except in compliance with the License.
10+
# You may obtain a copy of the License at
11+
#
12+
# http://www.apache.org/licenses/LICENSE-2.0
13+
#
14+
# Unless required by applicable law or agreed to in writing, software
15+
# distributed under the License is distributed on an "AS IS" BASIS,
16+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
# See the License for the specific language governing permissions and
18+
# limitations under the License.
19+
#

‎README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ These are important questions when there are millions of free and open source so
1212

1313
### Documentation Build Status
1414

15-
[![Build Status](https://travis-ci.org/nexB/aboutcode.svg?branch=master)](https://travis-ci.org/nexB/aboutcode)
15+
![Doc Build](https://github.com/nexB/aboutcode/actions/workflows/docs-ci.yml/badge.svg)
1616

1717
### Important Links
1818

@@ -30,6 +30,11 @@ AboutCode Documentation Group Email Addresses:
3030

3131
If you want to get in touch with the team with issues other than documentation, head to the gitter channel [here](https://gitter.im/aboutcode-org/discuss).
3232

33+
Look at our [wiki](https://github.com/nexB/aboutcode/wiki) for information about our participation
34+
in the GSoC and GSoD programs.
35+
36+
We have a weekly meeting, see more details [here](https://github.com/nexB/aboutcode/wiki/MeetingMinutes).
37+
3338
### Projects
3439

3540
Each AboutCode project has its own repository:
@@ -39,6 +44,8 @@ Each AboutCode project has its own repository:
3944
- **[Scancode.io](https://github.com/nexB/scancode.io)**: a web-based and
4045
API to run and review scans in rich scripted ScanPipe pipelines.
4146

47+
- **[VulnerableCode](https://github.com/nexB/vulnerablecode)**: an emerging server-side application to collect and track known package vulnerabilities.
48+
4249
- **[Scancode Workbench](https://github.com/nexB/scancode-workbench)**: a desktop application (based on Electron) to review the results of a scan and document your conclusions about the origin and license of software components and packages.
4350

4451
- **[AboutCode Toolkit](https://github.com/nexB/aboutcode-toolkit)**: a set of command line tools to document the provenance of your code and generate attribution notices. AboutCode Toolkit uses small yaml files to document code provenance inside a codebase. The lead maintainer is @chinyeungli
@@ -54,8 +61,6 @@ API to run and review scans in rich scripted ScanPipe pipelines.
5461
- **[DeltaCode](https://github.com/nexB/deltacode)**: a command line tool to compare scans and determine if and where there are material
5562
differences that affect licensing.
5663

57-
- **[VulnerableCode](https://github.com/nexB/vulnerablecode)**: an emerging server-side application to collect and track known package vulnerabilities.
58-
5964

6065
We also co-started and work closely with other FOSS orgs and projects:
6166

0 commit comments

Comments
 (0)