Skip to content

Commit

Permalink
modify javadoc warning of @ symbol for the pipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
yiliuTo committed Jul 1, 2020
1 parent a16301f commit 82ed2d2
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 6 deletions.
5 changes: 3 additions & 2 deletions eng/pipelines/scripts/generate_overview_from_readme.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.

# Use case: Given a README.md file, generate a readme_overview.html file and place it next
# Use case: Given a README.md file, generate a readme_overview.html file and place it next
# to the README.md. This will allow the javadocs jar step to append the contents of the
# readme onto the landing page.
#
#
# This script is necessary, instead of just invoking python markdown2 directly from the
# command line because the generated overview.html file needs to be enclosed inside of <body>
# tags. When the attach-javadocs runs with the overview option it will append it the contents
Expand Down Expand Up @@ -41,6 +41,7 @@ def generate_overview(readme_file, version):
# extras being passed into the markdown call is necessary to deal with the embedded
# code blocks within the readme so they'll displaye correctly in the html
html_readme_content = markdown2.markdown(readme_content, extras=["fenced-code-blocks"])
html_readme_content = html_readme_content.replace("@", "{@literal @}")

# Due to javadoc's iFrames the links need to target new tabs otherwise hilarity ensues
soup = BeautifulSoup(html_readme_content, "html.parser")
Expand Down
1 change: 0 additions & 1 deletion sdk/cosmos/azure-spring-data-cosmosdb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ Version mapping between spring boot and spring-data-cosmosdb:
```java
@Document(collection = "myCollection")
class MyDocument {
@Autowired
String id;
String data;
@Version
Expand Down
3 changes: 1 addition & 2 deletions sdk/cosmos/azure-spring-data-cosmosdb/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

<azure.test.resourcegroup>spring-data-cosmosdb-test</azure.test.resourcegroup>
<azure.test.dbname>testdb-${maven.build.timestamp}</azure.test.dbname>
<skip.integration.tests>false</skip.integration.tests>
<skip.integration.tests>true</skip.integration.tests>
<test.on.azure>false</test.on.azure>
<test.on.emualator>false</test.on.emualator>
</properties>
Expand Down Expand Up @@ -237,7 +237,6 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.1</version> <!-- {x-version-update;org.apache.maven.plugins:maven-javadoc-plugin;external_dependency} -->
<configuration>
<show>private</show>
<sourceFileExcludes>
<sourceFileExclude>com/microsoft/azure/spring/data/cosmosdb/core/mapping/BasicCosmosPersistentProperty.java</sourceFileExclude>
</sourceFileExcludes>
Expand Down
2 changes: 1 addition & 1 deletion sdk/cosmos/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ jobs:
- template: ../../eng/pipelines/templates/jobs/archetype-sdk-tests.yml
parameters:
TestName: Integration_Test_Spring_Data_Cosmosdb
ServiceDirectory: cosmos/azure-spring-data-cosmosdb
ServiceDirectory: cosmos
Artifacts:
- name: spring-data-cosmosdb
groupId: com.microsoft.azure
Expand Down

0 comments on commit 82ed2d2

Please sign in to comment.