Skip to content

Commit 9179a26

Browse files
mithromithro
authored
Merge pull request #33 from mithro/main
Adding Sphinx documentation generation for the docs.
2 parents b16d955 + d0fb39d commit 9179a26

File tree

11 files changed

+516
-3
lines changed

11 files changed

+516
-3
lines changed

‎.gitignore

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
.hypothesis/
51+
.pytest_cache/
52+
53+
# Translations
54+
*.mo
55+
*.pot
56+
57+
# Django stuff:
58+
*.log
59+
local_settings.py
60+
db.sqlite3
61+
62+
# Flask stuff:
63+
instance/
64+
.webassets-cache
65+
66+
# Scrapy stuff:
67+
.scrapy
68+
69+
# Sphinx documentation
70+
docs/_build/
71+
72+
# PyBuilder
73+
target/
74+
75+
# Jupyter Notebook
76+
.ipynb_checkpoints
77+
78+
# IPython
79+
profile_default/
80+
ipython_config.py
81+
82+
# pyenv
83+
env/
84+
.python-version
85+
86+
# celery beat schedule file
87+
celerybeat-schedule
88+
89+
# SageMath parsed files
90+
*.sage.py
91+
92+
# Environments
93+
.env
94+
.venv
95+
env/
96+
venv/
97+
ENV/
98+
env.bak/
99+
venv.bak/
100+
101+
# Spyder project settings
102+
.spyderproject
103+
.spyproject
104+
105+
# Rope project settings
106+
.ropeproject
107+
108+
# mkdocs documentation
109+
/site
110+
111+
# mypy
112+
.mypy_cache/
113+
.dmypy.json
114+
dmypy.json
115+
116+
# Pyre type checker
117+
.pyre/
118+
119+
# Emacs temporary files
120+
*~

‎.readthedocs.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
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+
# Build documentation in the docs/ directory with Sphinx
9+
sphinx:
10+
configuration: docs/conf.py
11+
12+
formats:
13+
- htmlzip
14+
15+
conda:
16+
environment: docs/environment.yml

‎docs/Makefile

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Copyright (C) 2017-2020 The SymbiFlow Authors.
2+
#
3+
# Use of this source code is governed by a ISC-style
4+
# license that can be found in the LICENSE file or at
5+
# https://opensource.org/licenses/ISC
6+
#
7+
# SPDX-License-Identifier: ISC
8+
# Minimal makefile for Sphinx documentation
9+
10+
11+
SHELL = /bin/bash
12+
MAKEDIR := $(dir $(lastword $(MAKEFILE_LIST)))
13+
14+
# You can set these variables from the command line.
15+
SPHINXOPTS =
16+
SPHINXBUILD = [ -e env/bin/activate ] && source env/bin/activate; sphinx-build
17+
SPHINXAUTOBUILD = [ -e env/bin/activate ] && source env/bin/activate; sphinx-autobuild
18+
SPHINXPROJ = SymbiFlowFIF
19+
SOURCEDIR = .
20+
BUILDDIR = _build
21+
OSFLAG =
22+
UNAME_S := $(shell uname -s)
23+
ifneq (, $(findstring Linux, $(UNAME_S)))
24+
OSFLAG := Linux
25+
endif
26+
ifeq ($(UNAME_S), Darwin)
27+
OSFLAG := MacOSX
28+
endif
29+
ifneq (, $(findstring Cygwin, $(UNAME_S)))
30+
OSFLAG := Linux
31+
endif
32+
ifneq (, $(findstring MINGW, $(UNAME_S)))
33+
OSFLAG := Linux
34+
endif
35+
36+
37+
# Put it first so that "make" without argument is like "make help".
38+
help:
39+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
40+
41+
livehtml:
42+
@$(SPHINXAUTOBUILD) -b html --ignore \*.swp --ignore \*~ $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html"
43+
44+
.PHONY: help livehtml Makefile
45+
46+
47+
env/Miniconda3-latest-$(OSFLAG)-x86_64.sh:
48+
mkdir env
49+
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-$(OSFLAG)-x86_64.sh -O env/Miniconda3-latest-$(OSFLAG)-x86_64.sh
50+
chmod a+x env/Miniconda3-latest-$(OSFLAG)-x86_64.sh
51+
52+
env:
53+
rm -rf env
54+
make env/Miniconda3-latest-$(OSFLAG)-x86_64.sh
55+
./env/Miniconda3-latest-$(OSFLAG)-x86_64.sh -p $(PWD)/env -b -f
56+
source env/bin/activate; conda config --system --add envs_dirs $(PWD)/env/envs
57+
source env/bin/activate; conda config --system --add pkgs_dirs $(PWD)/env/pkgs
58+
source env/bin/activate; conda env update --name base --file ./environment.yml
59+
60+
.PHONY: env
61+
62+
# Catch-all target: route all unknown targets to Sphinx using the new
63+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
64+
%:
65+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/_static/.keepme

Whitespace-only changes.

‎docs/bel_and_site_design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Cell, BEL and Site Design
1+
# Cell, BEL and Site Design
22

33
One of the key concepts within the FPGA interchange device resources is the
44
relationship between the cell library and the device BEL and site definitions.

0 commit comments

Comments
 (0)