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.

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

[Story] Create project to build, lint, test the monorepo docs site #2529

Open
1 task done
tschaffter opened this issue Feb 23, 2024 · 3 comments
Open
1 task done

[Story] Create project to build, lint, test the monorepo docs site #2529

tschaffter opened this issue Feb 23, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation python

Comments

@tschaffter
Copy link
Member

What product(s) is this story for?

Sage Monorepo

As a user, I want

As a Developer, I want to use the monorepo (Nx) API to develop the docs site so that I can focus on creating docs content.

Description

Notes:

  • Create a Python project in apps/sage-monorepo/docs
  • For the serve task, refer to the instruction given by @vpchung here.

Acceptance criteria

No response

Tasks

No response

Anything else?

No response

Have you linked this story to a GitHub Project?

  • I have linked this story to a GitHub Project and set its metadata.
@tschaffter tschaffter added documentation Improvements or additions to documentation python labels Feb 23, 2024
@tschaffter
Copy link
Member Author

mkdocs serve
ERROR   -  Config value 'plugins': The "mkdocstrings" plugin is not installed

Aborted with 1 configuration errors!

@vpchung
Copy link
Member

vpchung commented Feb 23, 2024

ERROR - Config value 'plugins': The "mkdocstrings" plugin is not installed

Whoops! I thought I had removed the plug-in from the configuration file (I didn't 😅 ). If you think we will use it, I will add it to the instructions so that local development is seamless.

@tschaffter
Copy link
Member Author

The extension will be removed in #2528

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python
Projects
None yet
Development

No branches or pull requests

2 participants