Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix markdown tables #28

Merged
merged 2 commits into from
Dec 16, 2020
Merged

docs: fix markdown tables #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45d5401
Add sphinx_markdown_tables
dgarcia360 Dec 15, 2020
3bb2b4e
Rollback table format
dgarcia360 Dec 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
# 'sphinx.ext.autosectionlabel',
'sphinx_scylladb_theme',
'sphinx_multiversion',
'recommonmark'
'recommonmark',
'sphinx_markdown_tables',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
6 changes: 2 additions & 4 deletions docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,9 +243,8 @@ expected output:

The code package structure is as follows:

+--------------+-------------------------------------+
| Name | Purpose |
+==============+=====================================+
| Name | Purpose |
| ------------ | ----------------------------------- |
| /api | swagger api spec |
| /cmd | applications executables |
| /cmd/migrate | install database schema |
Expand All @@ -256,7 +255,6 @@ The code package structure is as follows:
| /db/cql | database schema |
| /handler | swagger REST API handlers |
| /model | application models and ORM metadata |
+--------------+-------------------------------------+

After data is collected from the pets via the sensors on their collars, it is
delivered to the central database for analysis and for health status checking.
Expand Down
1 change: 1 addition & 0 deletions docs/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ sphinx-sitemap = "2.1.0"
sphinx-autobuild = "0.7.1"
Sphinx = "2.4.4"
sphinx-multiversion-scylla = "0.2.4"
sphinx-markdown-tables = "0.0.15"

[tool.poetry.dev-dependencies]
pytest = "5.2"
Expand Down