Skip to content

Update the instructions to build docs #16068

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

Merged
merged 1 commit into from
Nov 18, 2021

Conversation

javiereguiluz
Copy link
Member

Note: this build docs correctly ... but it has no styles and some images don't load correctly. I'd say it's fine to merge "as is" without waiting a long time until those issues are fixed.

Copy link
Member

@stof stof left a comment

Choose a reason for hiding this comment

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

Why ot using the CLI script maintained in the docs-builder package directly, which will stay uptodate with changes in the tool ?

"symfony/process": "^5.2",
"symfony-tools/docs-builder": "^0.15.0"
"symfony/console": "^5.4",
"symfony/process": "^5.4",
Copy link
Member

Choose a reason for hiding this comment

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

symfony/process looks unused now

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes ... but let's wait and see if we finally revert to using the script directly. Thanks!

@javiereguiluz
Copy link
Member Author

About using the script or not ... to be honest I never liked the script. The doc building is something "internal", so I think it's better to have absolute control ... and expose the entire feature via a command to end-users.

For example, does the CLI command provide arguments/options to configure all this that we use here? I haven't checked. Just asking.

        $buildConfig = (new BuildConfig())
            ->setSymfonyVersion('4.4')
            ->setContentDir(__DIR__.'/..')
            ->setOutputDir($outputDir)
            ->setImagesDir(__DIR__.'/output/_images')
            ->setImagesPublicPrefix('_images')
            ->setTheme('sfdocs')
        ;

@wouterj
Copy link
Member

wouterj commented Nov 9, 2021

Not sure, but if it hasn't we can always add it (as docs builder is an internal library, we can move quickly and add and remove things as we wish).

I do agree with @stof that it is much easier to update the code in 1 repo, instead of 2 (having to do it in 2 actually blocks us from moving quickly).

I can see why the tool isn't used on symfony.com: using the process component and such feels "not optimal". But for the CI of the docs repo (and maybe also the CI for the hosted bundle docs), having a single tool (maybe even a github action) makes things easier imho.

@javiereguiluz javiereguiluz merged commit 0e69311 into symfony:4.4 Nov 18, 2021
@javiereguiluz javiereguiluz deleted the update_readme branch November 18, 2021 09:59
@javiereguiluz
Copy link
Member Author

@stof @wouterj I've merged this PR despite your comments. It's not that I'm ignoring them ... but updating the README and the doc build instructions is urgent (we still mention Sphinx, etc.)

So, given that making the change that you propose will be transparent to end users, we can do it later in a separate PR whenever we want. I hope you understand this 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants