Skip to content

Commit 706b519

Browse files
authored
Merge pull request #1083 from domaframework/chore/docs
Update documents
2 parents f185c3c + f598bb4 commit 706b519

File tree

2 files changed

+4
-43
lines changed

2 files changed

+4
-43
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -48,24 +48,14 @@ You can check the last publication date here:
4848

4949
- https://oss.sonatype.org/content/repositories/snapshots/org/seasar/doma/
5050

51-
### IDE
52-
53-
#### IntelliJ IDEA
51+
### IDE - IntelliJ IDEA
5452

5553
Import the root directory as a Gradle project.
5654

57-
#### Eclipse
58-
59-
Before importing, run the Gradle `eclipse` command in the root directory:
60-
61-
```
62-
$ ./gradlew eclipse
63-
```
64-
6555
### Code Style
6656

6757
We use [spotless](https://github.com/diffplug/spotless) and
68-
[google-java-format](https://github.com/google/google-java-format) 1.7 for code formatting.
58+
[google-java-format](https://github.com/google/google-java-format) for code formatting.
6959

7060
To format, just run the Gradle `build` task:
7161

@@ -78,28 +68,4 @@ see https://github.com/google/google-java-format#using-the-formatter.
7868

7969
### Documentation
8070

81-
We use [Sphinx](http://sphinx-doc.org) to generate documents.
82-
The generated documents are hosted on the ReadTheDocs.
83-
84-
- https://doma.readthedocs.io/
85-
86-
To use Sphinx, you need Python.
87-
88-
#### Install Sphinx
89-
90-
Navigate to the docs directory and run the `pip install` command:
91-
92-
```
93-
$ cd docs
94-
$ pip install -r requirements.txt
95-
```
96-
97-
#### Generate HTML files
98-
99-
Execute the `sphinx-autobuild` command in the docs directory:
100-
101-
```
102-
$ sphinx-autobuild . _build/html
103-
```
104-
105-
Visit the webpage served at http://127.0.0.1:8000.
71+
See https://github.com/domaframework/doma-docs

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Doma has various strengths:
1111
- Has no dependence on other libraries.
1212

1313
[![Build Status](https://github.com/domaframework/doma/workflows/Java%20CI%20with%20Gradle/badge.svg)](https://github.com/domaframework/doma/actions?query=workflow%3A%22Java+CI+with+Gradle%22)
14-
[![docs](https://readthedocs.org/projects/doma/badge/?version=latest)](https://doma.readthedocs.io/en/latest/)
1514
[![javadoc](https://javadoc.io/badge2/org.seasar.doma/doma-core/javadoc.svg)](https://javadoc.io/doc/org.seasar.doma/doma-core)
1615
[![project chat](https://img.shields.io/badge/zulip-join_chat-green.svg)](https://domaframework.zulipchat.com)
1716
[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/domaframework)
@@ -85,11 +84,7 @@ for more information.
8584

8685
### More Examples
8786

88-
Try [Getting started](https://doma.readthedocs.io/en/latest/getting-started/).
89-
90-
For more complete examples,
91-
see [simple-examples](https://github.com/domaframework/simple-examples)
92-
and [spring-boot-jpetstore](https://github.com/domaframework/spring-boot-jpetstore).
87+
Try [Getting started](https://doma.readthedocs.io/en/latest/getting-started/) and [simple-examples](https://github.com/domaframework/simple-examples).
9388

9489
Installing
9590
----------

0 commit comments

Comments
 (0)