Skip to content

Commit cdbb238

Browse files
committed
Docs: fix minor UX issues (#42)
* develop: Docs: fix minor UX issues (#42) feat: add algolia search for docs and api ref (#39)
2 parents 241bff4 + 4b03ddc commit cdbb238

File tree

5 files changed

+45
-293
lines changed

5 files changed

+45
-293
lines changed

Diff for: Makefile

+3-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ build-docs:
3333
@$(MAKE) build-docs-website
3434
@$(MAKE) build-docs-api
3535

36-
build-docs-api: dev
37-
poetry run pdoc --html --output-dir dist/api/ ./aws_lambda_powertools --force
36+
build-docs-api:
37+
pip install pdoc3~=0.7.5
38+
pdoc3 --html --output-dir dist/api/ ./aws_lambda_powertools --force
3839
mv dist/api/aws_lambda_powertools/* dist/api/
3940
rm -rf dist/api/aws_lambda_powertools
4041

Diff for: docs/gatsby-config.js

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1+
const docsWebsite = "https://awslabs.github.io/aws-lambda-powertools-python"
2+
13
module.exports = {
24
pathPrefix: '/aws-lambda-powertools-python',
35
siteMetadata: {
46
title: 'AWS Lambda Powertools Python',
57
description: 'A suite of utilities for AWS Lambda Functions that makes tracing with AWS X-Ray, structured logging and creating custom metrics asynchronously easier',
68
author: `Amazon Web Services`,
79
siteName: 'AWS Lambda Powertools Python',
8-
siteUrl: 'https://awslabs.github.io/aws-lambda-powertools-python'
10+
siteUrl: `${docsWebsite}`
911
},
1012
plugins: [
1113
{
@@ -14,9 +16,10 @@ module.exports = {
1416
root: __dirname,
1517
menuTitle: 'Helpful resources',
1618
githubRepo: 'awslabs/aws-lambda-powertools-python',
17-
baseUrl: 'https://awslabs.github.io/aws-lambda-powertools-python',
19+
baseUrl: `${docsWebsite}`,
1820
algoliaApiKey: 'a8491b576861e819fd50d567134eb9ce',
1921
algoliaIndexName: 'aws-lambda-powertools-python',
22+
logoLink: `${docsWebsite}`,
2023
sidebarCategories: {
2124
null: [
2225
'index'
@@ -69,7 +72,6 @@ module.exports = {
6972
},
7073
'gatsby-plugin-antd',
7174
'gatsby-remark-autolink-headers',
72-
'gatsby-plugin-offline',
7375
'gatsby-plugin-sitemap'
7476
]
7577
};

0 commit comments

Comments
 (0)