Skip to content

Commit

Permalink
feat(docs): add google/auth to refdocs (#8047)
Browse files Browse the repository at this point in the history
* feat(docs): add google/auth to refdocs

* remove \Google\Auth linking to external docs

* update refdocs in fixtures

* Update phpunit.xml.dist

* see if upgrading phpdoc fixes it

* upgrade to 3.5.3
  • Loading branch information
bshaffer authored Feb 2, 2025
1 parent af302a6 commit 21efdf5
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
id: extract
uses: shrink/actions-docker-extract@v2
with:
image: "phpdoc/phpdoc:3.4.1"
image: "phpdoc/phpdoc:3.5.3"
path: "/opt/phpdoc/."
- name: Symlink phpDocumentor
run: ln -s $(pwd)/${{ steps.extract.outputs.destination }}/bin/phpdoc /usr/local/bin/phpdoc
Expand Down
9 changes: 9 additions & 0 deletions .kokoro/docs/publish.sh
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ $PROJECT_DIR/dev/google-cloud docfx \
$STAGING_FLAG \
$VERBOSITY_FLAG

# Add Auth repo
AUTH_DIR=$PROJECT_DIR/dev/vendor/google/auth
$PROJECT_DIR/dev/google-cloud docfx \
--path $AUTH_DIR \
--out auth-out \
--metadata-version $(cat $AUTH_DIR/VERSION) \
$STAGING_FLAG \
$VERBOSITY_FLAG

# If this run after a release, store the released artifacts.
if [ "$KOKORO_GITHUB_COMMIT" != "" ]; then
# Move to the project directory
Expand Down
3 changes: 0 additions & 3 deletions dev/src/DocFx/Node/XrefTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,6 @@ private function replaceUidWithLink(string $uid, ?string $name = null): string

// Check for external package namespaces
switch (true) {
case str_starts_with($uid, '\Google\Auth\\'):
$extLinkRoot = 'https://googleapis.github.io/google-auth-library-php/main/';
break;
case str_starts_with($uid, '\Google\Protobuf\\'):
$extLinkRoot = 'https://protobuf.dev/reference/php/api-docs/';
break;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ items:
-
id: '↳ credentials'
var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper
description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed <a href="https://googleapis.github.io/google-auth-library-php/main/Google/Auth/FetchAuthTokenInterface">Google\Auth\FetchAuthTokenInterface</a> object or <xref uid="\Google\ApiCore\CredentialsWrapper">Google\ApiCore\CredentialsWrapper</xref> object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.'
description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed <xref uid="\Google\Auth\FetchAuthTokenInterface">Google\Auth\FetchAuthTokenInterface</xref> object or <xref uid="\Google\ApiCore\CredentialsWrapper">Google\ApiCore\CredentialsWrapper</xref> object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.'
-
id: '↳ credentialsConfig'
var_type: array
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ items:
-
id: '↳ credentials'
var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper
description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed <a href="https://googleapis.github.io/google-auth-library-php/main/Google/Auth/FetchAuthTokenInterface">Google\Auth\FetchAuthTokenInterface</a> object or <xref uid="\Google\ApiCore\CredentialsWrapper">Google\ApiCore\CredentialsWrapper</xref> object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.'
description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed <xref uid="\Google\Auth\FetchAuthTokenInterface">Google\Auth\FetchAuthTokenInterface</xref> object or <xref uid="\Google\ApiCore\CredentialsWrapper">Google\ApiCore\CredentialsWrapper</xref> object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.'
-
id: '↳ credentialsConfig'
var_type: array
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ items:
-
id: '↳ credentials'
var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper
description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed <a href="https://googleapis.github.io/google-auth-library-php/main/Google/Auth/FetchAuthTokenInterface">Google\Auth\FetchAuthTokenInterface</a> object or <xref uid="\Google\ApiCore\CredentialsWrapper">Google\ApiCore\CredentialsWrapper</xref> object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.'
description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed <xref uid="\Google\Auth\FetchAuthTokenInterface">Google\Auth\FetchAuthTokenInterface</xref> object or <xref uid="\Google\ApiCore\CredentialsWrapper">Google\ApiCore\CredentialsWrapper</xref> object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.'
-
id: '↳ credentialsConfig'
var_type: array
Expand Down

0 comments on commit 21efdf5

Please sign in to comment.