Fix build output directory for ref docs in CONTRIBUTING.md by cprayer · Pull Request #26556 · spring-projects/spring-framework

cprayer · 2021-02-16T17:07:53Z

Lines 150 to 168 in fd49c8f

    
           /** 
        
            * Generate the Spring Framework Reference documentation from "src/docs/asciidoc" 
        
            * in "build/docs/ref-docs/html5". 
        
            */ 
        
           asciidoctor { 
        
           	baseDirFollowsSourceDir() 
        
           	configurations 'asciidoctorExt' 
        
           	sources { 
        
           		include '*.adoc' 
        
           	} 
        
           	outputDir "$buildDir/docs/ref-docs/html5" 
        
           	logDocuments = true 
        
           	resources { 
        
           		from(sourceDir) { 
        
           			include 'images/*.png', 'css/**', 'js/**' 
        
           		} 
        
           		from extractDocResources 
        
           	} 
        
           }

(fd49c8f is latest commit of master branch)
As you can see, I think it should be build/docs/ref-docs/html5 directory, not a build/asciidoc/html5 directory.

sbrannen · 2021-02-16T17:22:12Z

Good catch.

This has been merged into master.

Thanks

Closes spring-projectsgh-26556

Fix invalid build refdoc output directory in CONTRIBUTING.md

bbc3f14

spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Feb 16, 2021

sbrannen self-assigned this Feb 16, 2021

sbrannen added type: documentation A documentation task and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Feb 16, 2021

sbrannen added this to the 5.3.5 milestone Feb 16, 2021

sbrannen changed the title ~~Fix invalid build refdoc output directory in CONTRIBUTING.md~~ Fix build output directory for ref docs in CONTRIBUTING.md Feb 16, 2021

sbrannen merged commit 7ca47cf into spring-projects:master Feb 16, 2021

cprayer deleted the fix-CONTRIBUTING-md branch February 17, 2021 00:40

lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this pull request Mar 26, 2022

Fix build output dir for ref docs in CONTRIBUTING.md

1974507

Closes spring-projectsgh-26556

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix build output directory for ref docs in CONTRIBUTING.md#26556

Fix build output directory for ref docs in CONTRIBUTING.md#26556
sbrannen merged 1 commit intospring-projects:masterfrom
cprayer:fix-CONTRIBUTING-md

cprayer commented Feb 16, 2021

Uh oh!

sbrannen commented Feb 16, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

	/**
	* Generate the Spring Framework Reference documentation from "src/docs/asciidoc"
	* in "build/docs/ref-docs/html5".
	*/
	asciidoctor {
	baseDirFollowsSourceDir()
	configurations 'asciidoctorExt'
	sources {
	include '*.adoc'
	}
	outputDir "$buildDir/docs/ref-docs/html5"
	logDocuments = true
	resources {
	from(sourceDir) {
	include 'images/.png', 'css/', 'js/*'
	}
	from extractDocResources
	}
	}

Conversation

cprayer commented Feb 16, 2021

Uh oh!

sbrannen commented Feb 16, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments