Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

fix godoc building and update #277

Merged
merged 1 commit into from
Sep 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 2 additions & 13 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,7 @@ ipfs-theme:
$(PREPEND)cp ./node_modules/ipfs-css/fonts/Inter-UI* ./build/assets/fonts/ $(APPEND)
$(PREPEND)node scripts/ipfs-css-constants.js $(APPEND)

packages:
# The JS packages don't actually generate useful docs right now, so skip them
# $(PREPEND)scripts/pkg2md.sh github.com/ipfs/js-ipfs-http-client master $(PKGDIR) pkg
# $(PREPEND)scripts/pkg2md.sh github.com/ipfs/js-ipfs master $(PKGDIR) pkg
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/go-ipfs-api v0.0.2 $(PKGDIR) go/pkg
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/go-ipfs-http-client v0.0.3 $(PKGDIR) go/pkg
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/interface-go-ipfs-core v0.1.0 $(PKGDIR) go/pkg
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/interface-go-ipfs-core/options v0.1.0 $(PKGDIR) go/pkg
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/interface-go-ipfs-core/path v0.1.0 $(PKGDIR) go/pkg
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/interface-go-ipfs-core/options/namesys v0.1.0 $(PKGDIR) go/pkg

resources: ipfs-theme packages
resources: ipfs-theme

install: node_modules resources

Expand Down Expand Up @@ -86,4 +75,4 @@ clean:
$(PREPEND)[ ! -d $(PKGDIR) ] || rm -rf $(PKGDIR)/*/
$(PREPEND)[ ! -d build/assets ] || rm -rf build/assets/*

.PHONY: packages build help deploy publish-to-domain clean
.PHONY: build help deploy publish-to-domain clean
25 changes: 13 additions & 12 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -95,25 +95,26 @@ identifier = "go_implementation"
name = "Go Implementation"
weight = 5
[[menu.reference]]
identifier = "go_coreapi"
parent = "go_implementation"
name = "go-ipfs Core API"
url = "/go/pkg/go-ipfs/core/coreapi"
weight = 10
[[menu.reference]]
parent = "go_implementation"
name = "go-ipfs Coreiface API"
url = "/go/pkg/go-ipfs/core/coreapi/interface"
name = "Go Core API"
url = "https://godoc.org/github.com/ipfs/interface-go-ipfs-core"
weight = 11
[[menu.reference]]
parent = "go_implementation"
name = "go-ipfs Core options API"
url = "/go/pkg/go-ipfs/core/coreapi/interface/options"
name = "Go HTTP Client (experimental)"
url = "https://godoc.org/github.com/ipfs/go-ipfs-http-client"
weight = 12
[[menu.reference]]
parent = "go_implementation"
name = "go-ipfs-api Reference"
url = "/go/pkg/go-ipfs-api"
weight = 30
name = "Go Embedded Client (experimental)"
url = "https://godoc.org/github.com/ipfs/go-ipfs/core/coreapi"
weight = 13
[[menu.reference]]
parent = "go_implementation"
name = "Go HTTP Client (old but stable)"
url = "https://godoc.org/github.com/ipfs/interface-go-ipfs-core"
weight = 15

[[menu.reference]]
identifier = "js_implementation"
Expand Down
56 changes: 38 additions & 18 deletions content/reference/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ menu:

This document is autogenerated from <a href='https://github.com/ipfs/docs/blob/master/scripts/cli.sh'>scripts/cli.sh</a>. For issues and support, check out the <a href='https://github.com/ipfs/docs'>docs repository</a> on GitHub.

*Generated on 2019-07-16 15:20:49, from go-ipfs 0.4.21.*
*Generated on 2019-08-30 18:40:23, from go-ipfs 0.4.22.*

- [ipfs](#ipfs)
- [ipfs add](#ipfs-add)
Expand Down Expand Up @@ -541,10 +541,10 @@ OPTIONS
DESCRIPTION

'ipfs block put' is a plumbing command for storing raw IPFS blocks.
It reads from stdin, and <key> is a base58 encoded multihash.
It reads from stdin, and outputs the block's CID to stdout.

By default CIDv0 is going to be generated. Setting 'mhtype' to anything other
than 'sha2-256' or format to anything other than 'v0' will result in CIDv1.
Unless specified, this command returns dag-pb CIDv0 CIDs. Setting 'mhtype' to anything
other than 'sha2-256' or format to anything other than 'v0' will result in CIDv1.


```
Expand Down Expand Up @@ -1010,6 +1010,17 @@ SYNOPSIS
DESCRIPTION

Available profiles:
'randomports':
Use a random port number for swarm.
'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.
'default-networking':
Restores default network settings.
Inverse profile of the test profile.
Expand Down Expand Up @@ -1045,17 +1056,6 @@ DESCRIPTION
functionality - performance of content discovery and data
fetching may be degraded.

'randomports':
Use a random port number for swarm.
'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.

SUBCOMMANDS
ipfs config profile apply <profile> - Apply profile to config.
Expand Down Expand Up @@ -4517,9 +4517,29 @@ DESCRIPTION
## ipfs update

```
ipfs-update is an 'external' command.
It does not currently appear to be installed.
Please refer to the ipfs documentation for instructions.
NAME:
ipfs-update - Update ipfs.

USAGE:
ipfs-update [global options] command [command options] [arguments...]

VERSION:
1.5.3-dev

COMMANDS:
versions Print out all available versions.
version Print out currently installed version.
install Install a version of ipfs.
stash stashes copy of currently installed ipfs binary
revert Revert to previously installed version of ipfs.
fetch Fetch a given version of ipfs. Default: latest.
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--verbose Print verbose output.
--distpath value specify the distributions build to use
--help, -h show help
--version, -v print the version
```

## ipfs urlstore
Expand Down
4 changes: 2 additions & 2 deletions content/reference/go/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ For more technical information about building, debugging or using the API, see:

If you plan to use `go-ipfs` as a package in your own Go application, you can take any of three main approaches:

- Use **[`go-ipfs`](https://github.com/ipfs/go-ipfs)** to run IPFS directly in your own process. See [the API reference](/go/pkg/go-ipfs/core/coreapi).
- Use **[`go-ipfs-api`](https://github.com/ipfs/go-ipfs-api)** to communicate with an IPFS daemon in a separate process via its HTTP API (this is what `go-ipfs` does if a daemon is already running). See [the API reference](/go/pkg/go-ipfs-api).
- Use **[`go-ipfs`](https://github.com/ipfs/go-ipfs)** to run IPFS directly in your own process. See the [CoreAPI constructor](/go/pkg/go-ipfs/core/coreapi).
- Use **[`go-ipfs-htp-client`](https://github.com/ipfs/go-ipfs-http-client)** to communicate with an IPFS daemon in a separate process via its HTTP API (this is what `go-ipfs` does if a daemon is already running). See the [http client](/go/pkg/go-ipfs-http-client).
- Use other Go packages to communicate with the HTTP API directly. See the [HTTP API reference](/api/http).
5 changes: 0 additions & 5 deletions go.mod

This file was deleted.

4 changes: 0 additions & 4 deletions go.sum

This file was deleted.

92 changes: 0 additions & 92 deletions scripts/pkg2md.sh

This file was deleted.