Skip to content

Commit 5a0c042

Browse files
committed
Add note about the documentation to the README
As the documentation's using Antora instead of Sphinx-Doc, it's essential to work to take users along on the journey with us. So by documenting the change in the readme, and by providing links to further reading, I hope that they'll be amenable to the change.
1 parent 6e62cf7 commit 5a0c042

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@ Past maintainers:
6161
* Daniel Molkentin <[email protected]>
6262
* Andreas Schneider <[email protected]>
6363

64+
## Building the Documentation
65+
66+
The documentation has been migrated from Sphinx-Doc to [Antora](https://docs.antora.org/), which is based on [the AsciiDoc format](https://github.com/owncloud/docs/blob/master/docs/getting-started.md).
67+
For the moment, it is not possible to generate the client documentation directly, as was previously the case, via a CMake command.
68+
Instead, the client documentation is built when the entire ownCloud documentation is built; (this is a combination of the _administration_, _developer_, and _user_, _iOS_, and _Android_ manuals).
69+
70+
**Please note:** investigations are underway to see if it can be built both standalone and as as part of the larger documentation bundle.
71+
This README will be updated as more information is available.
72+
6473
## License
6574

6675
This program is free software; you can redistribute it and/or modify

0 commit comments

Comments
 (0)