Skip to content

feat: add 'serve' command to Makefile and make.bat for serving documentation #698

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

germa89
Copy link
Contributor

@germa89 germa89 commented May 13, 2025

As the title. For better developer experience.

I am running on macOS, so I couldnt check the bat file. The Makefile does work though!

@germa89 germa89 requested a review from a team as a code owner May 13, 2025 15:00
@germa89 germa89 self-assigned this May 13, 2025
@github-actions github-actions bot added enhancement General improvements to existing features docs Issues related to documentation labels May 13, 2025
@germa89
Copy link
Contributor Author

germa89 commented May 14, 2025

@Revathyvenugopal162 CI jobs CI/Vale seems redundant with Doc style...

@jorgepiloto
Copy link
Member

We are moving from these files to tox. In fact, there is the tox -e doc-serve command, which serves the documentation right now.

@germa89
Copy link
Contributor Author

germa89 commented May 14, 2025

I dont mind tox or make file. But I think we should use one of those, since the purpose of them is to unify the repository commands.

Comment on lines +37 to +40
# Serve docs
serve:
@echo "Serving docs..."
@cd ../ && stb serve $(DOCSDIR)/$(SOURCEDIR)
Copy link
Member

Choose a reason for hiding this comment

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

I this is is another argument in favor of just going with Tox. Tox manages paths the right way. Adding this forces us to run the Makefile only from the base directory.

Copy link
Contributor Author

@germa89 germa89 left a comment

Choose a reason for hiding this comment

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

Just some comments. But it looks good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues related to documentation enhancement General improvements to existing features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants