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: API auto-mentioning in docs (#910) #1305

Merged
merged 8 commits into from
May 19, 2020
Merged

docs: API auto-mentioning in docs (#910) #1305

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
800c98c
docs: api markdown code linker
mvshmakov May 18, 2020
c6a0881
docs: api and command markdown code tests
mvshmakov May 18, 2020
d4d5405
docs: manual links to api method pages removed
mvshmakov May 18, 2020
71921db
docs: codeclimate fixes
mvshmakov May 18, 2020
ec953a3
docs: test fixes
mvshmakov May 18, 2020
a591ad0
docs-910: helpers refactoring
mvshmakov May 19, 2020
2970bff
docs-910: bringing back formatting
mvshmakov May 19, 2020
ee558de
docs-910: indent fix and redundant url removal
mvshmakov May 19, 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
2 changes: 1 addition & 1 deletion content/docs/install/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
DVC can be used as a Python library, simply install it with a package manager
like `pip` or `conda`, and as a Python
[project requirement](https://pip.pypa.io/en/latest/user_guide/#requirements-files)
if needed. The [Python API](/doc/api-reference) module is `dvc.api`.
if needed. The Python API module is `dvc.api`.

## Advanced options

Expand Down
8 changes: 4 additions & 4 deletions content/docs/use-cases/data-registries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@ the project dependency metadata in the import stage (DVC-file).

### Programmatic reusability of DVC data

Our Python API, included with the `dvc` package installed with DVC, includes the
`open` function to load/stream data directly from external <abbr>DVC
projects</abbr>:
Our Python API (`dvc.api`), included with the `dvc` package installed with DVC,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I would actually prefer to link [Python API] manually for readability.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 036672d along with a couple more instances I found.

includes the `open` function to load/stream data directly from external
<abbr>DVC projects</abbr>:

```python
import dvc.api.open
Expand Down Expand Up @@ -202,7 +202,7 @@ and this will be picked up by Git:
$ git status
Changes not staged for commit:
...
modified: music/songs.dvc
modified: music/songs.dvc
$ git commit -am "Add 1,000 more songs to music/ dataset."
```

Expand Down